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

pietrofxq
I’ve bought the following books: Programming Elixir 1.6 Programming Phoenix 1.4 Programming Ecto Functional Web Development with Elixir...
New
wolfiton
Hi everyone, How can i retrieve the name from a structure like this? %{"id" => "1570", "name" => "Croque Monsieur"} My test loo...
New
zeroexcuses
Besides Basic types - The Elixir programming language are there any other well recommended “elixir by example” style resources / books ? ...
New
sadcad
I love the Phoenix and Elixir docs, but I always tend to learn faster when I watch a video of someone explaining things and then I implem...
New
svetarosemond
I’m planning on purchasing Elixir in action second edition, and I was wondering if anyone could tell me based off the first edition, does...
New
woohaaha
I’m coming from Ruby and Rails. I have read some Elixir and Phoenix books. They shed a lot of light about building applications in Elixir...
New
Nvim
Anybody know of a Pragmatic Studio 40% off coupon code for video course like Phoenix?
New
g5becks
Hello everyone. So I just got done reading all of the introduction to Elixir and working through the basics of the language. I am not new...
New
boddhisattva
Greetings everyone, At my current workplace we're evaluating different ways of building a microservices architecture for some parts rel...
New
SavagePixie
I was wondering if there are any beginner-friendly, exercise-based resources for learning Elixir out there. I’m looking for something lik...
New

Other popular topics Top

New
SoCreat
i’m a new one to elixir which editor can i use vs code? or atom? Thanks! :smiley:
New
vertexbuffer
Hello, can anybody help here..? I have a list of players and I what to delete an element, but every for loop the list is reverting to ori...
New
minhajuddin
I have seen a lot of code which picks the first element from a list using Enum.at(0) instead of List.first. Is there a reason why people ...
New
rms.mrcs
Hi, I need to transform a list of numbers into a map where the keys are the indexes and the values are the original values of the list....
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? https://hexdocs.pm/ecto/Ecto.Repo.h...
New
johnnyicon
Hi all, I've just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage. I'm trying to use Postg...
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID<0.412.0> terminating ** (Postgrex.Error) FATAL...
New
josevalim
Hi everyone, One of the features added to Elixir early on to help integration with Erlang code was the idea of overridable function defi...
New
Nvim
Elixir appears to be a superior language to Python. I don’t see any advantage of Python over Elixir. Are there any?
New

We're in Beta

About us Mission Statement