thiagomajesk

thiagomajesk

Is there something like a friendlier version of the Erlang docs?

Since I first started experimenting with Elixir I see myself digging slowly to discover more about how powerful Erlang is…Besides that, @josevalim went on Twitter the other day to talk about how dependencies are your responsibility and this got me wondering how much more from OTP I could be utilizing in my code without resorting to “external” dependencies (which I’m making a distinction here).

So I’ve been browsing Erlang Docs now and then and I have to say: from my perspective, the way things are documented in the Elixir realm has spoiled me too much :grimacing:

I don’t know if it’s just me that cares about that, but Erlang’s documentation does not strike me as the most effective nor user-friendly of all. I also don’t know if part of this is because I haven’t got the opportunity to actually study more about Erlang itself, so everything looks extra-weird in my eyes (somewhat hard to read).

So, I was wondering if there’s some kind of initiative to “modernize” Erlang’s documentation. Or someplace else that presents things in a more friendly manner.

Most Liked

cmkarlsson

cmkarlsson

How about: Search - Erlang/OTP ?

or https://erldocs.com/?

or https://erlang.org/doc/pdf/otp-system-documentation.pdf and use pdf search tools? This is not the best but the table of contents itself is pretty good and usually directs me to the correct place (might be I have too much assumed knowledge)

And then of course erl -man <module> if you know what module you are after. Use a pager you a familiar with and use the search capabilities of the pager.

hauleth

hauleth

Yes, EEP 48 and there is more coming.

About viewing Erlang docs - either use the one with search, or check documentation browsers like Dash or devdocs.io, it will make it much easier to search through documentation.

Where Next?

Popular in Discussions Top

Donovan
Hello everyone, I’m so glad to have discovered this awesome community. Thanks for creating it! This is my second post, and apologies for...
New
arpan
Hello everyone :wave: Today I am very excited to announce a project that I have been working on for almost 3 months now. The project is...
New
lucaong
Hello Elixir and Nerves community, I have been working for a while on an open-source embedded key-value database for Elixir, that I call...
230 14027 124
New
Crowdhailer
I’ve been hearing much about the new formatter and it’s something I have been keen to try. I find examples buy far the most illuminating...
248 19327 150
New
shishini
I think this twitter post and youtube video didn’t get as much attention as I hoped I am still new to Elixir, so can’t really judge ...
New
chulkilee
Here are the list of HTTP client libraries/wrappers, and some thoughts on HTTP client in general. I’d like to hear from others how they w...
New
griffinbyatt
Sobelow Sobelow is a security-focused static analysis tool for the Phoenix framework. For security researchers, it is a useful tool for g...
New
opsb
We’re considering our architecture from a viewpoint of scaling our traffic heavily over the next 6 months. Our current deployment is runn...
New
dogweather
I wrote this comment on r/haskell, and it’s not popular there. :wink: But I think I’m on to something… Haskell reminds me of Java, and e...
New
slashdotdash
Phoenix Live View is now publicly available on GitHub. Here’s Chris McCord’s tweet announcing making it public.
New

Other popular topics Top

aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
WestKeys
Currently suffering from paralysis by [HTTP client] analysis. This is rather unusual in Elixirland as there tends to be consensus on the ...
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
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
jason.o
In the code below, if the create action is not set to accept “extra_key” as an input, it errors out with a message shown above. Is there ...
New
boundedvariable
I am going through the kafka architecture. All the features what the kafka is providing are already in Erlang. I would like hear your opi...
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
PeterCarter
There are pre-rolled solutions for other frameworks that do work. However, Phoenix does not seem to have these. Have people had good expe...
New
JorisKok
I have a server on AWS, and was running a load test using artillery. When looking at the Phoenix dashboard I see the Ports going to 100% ...
New
dogweather
I wrote this comment on r/haskell, and it’s not popular there. :wink: But I think I’m on to something… Haskell reminds me of Java, and e...
New

Latest on Elixir Forum

Elixir Forum

We're in Beta

About us Mission Statement