KP123

KP123

Adding PHP style user contributed notes to Hex docs

Hello, is there any chance that a user contributed notes section, like the one in the PHP documentation, can be added to Hex docs? It would be nice to have something similar to the new anti pattern docs on every relevant module page, but more in depth. The forum is nice but it would be nice to have a quick summary of all the gotchas in one place.

Most Liked

sodapopcan

sodapopcan

While I did really enjoy those comment sections back in my PHP days with Elixir, just make PRs. José and co. are amazing about doc contributions. PRs are usually reviewed within a day. I’ve once had one accepted in under 20 mins from opening it! The big benefit here is that it gets vetted by the team and doesn’t have to rely on an upvoting system. José has even added to and reworded a PR I made to improve it. That particular contribution was largely centred around a gotcha much in the spirit of those PHP comments :slight_smile: So even if you are unsure about what you’re contributing, it will get the ball rolling and others can help to fix it (or you can post it here first, of course).

Otherwise, hexdocs are static HTML so I think implementing a dynamic section that would require an upvote system would very likely be a non-starter.

LostKobrakai

LostKobrakai

Yeah, hexdocs hosted docs are heavily cached on a CDN. People are using external tools like e.g. Dash to browse docs. And most importantly docs are not just exported as HTML, but at least also in epub format, but generally any format someone builds a formatter for.

A dynamic comment system would at best cover only a small subset of usecases around elixir documentation - unless comments would also somehow feed back into where documentation is built.

Additionally one may not forget that once you allow people to post anyting to a public place you need people to moderate that – which in the age of AI only becomes an increasingly more complex task.

All that said I want to mirror @sodapopcan post that improving the docs themselves is the more scalable approach, even if it requires maintainers of libraries to collaborate to get those changes in.

Where Next?

Popular in Chat/Questions Top

boddhisattva
Greetings everyone, At my current workplace we’re evaluating different ways of building a microservices architecture for some parts rela...
New
asfand
Hi Everyone, I am a student and know basics of web development, used some php and ruby, but I am not an expert in any. I want to learn E...
New
wolfiton
Question: Can someone recommend me some good resources on learning performance for phoenix elixir applications and a design pattern I sh...
New
Iex.new
Hello!, I just started this week to discover Elixir. I’m a PHP-Programmer and did some sutff in Go too. The more I read about Elixir t...
New
koen_vb
Hi, I was looking for a pointer of how I could most easily start with phoenix regarding deploying it to something like linode or google c...
New
stevensonmt
I’d like to provide my review of the Elixir Course module from Groxio. I have some criticisms but I’d like to start with the positives. ...
New
Sujit
Hi Team From the title, I am entirely new to programming and i am interested in learning elixir but not sure where to start. Can someone...
New

Other popular topics Top

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
lanycrost
Hi everyone! I need implement if…else if…else condition from my elixir code, and anymore of this control flow structures not work proper...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
greenz1
I have a phoenix application from which a user can download multiple(5-6) files of size 1MB. I couldn’t find anything related to sending ...
New
TunkShif
This post is an instruction guide to help you setup your Neovim for Elixir development from scratch. It includes general information on h...
274 42533 114
New
sergio
Kind of like when jquery came out, it was super necessary. Existing drag and drop libraries have a bunch of baggage to support old browse...
New

We're in Beta

About us Mission Statement