Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Look at the Elixir and Phoenix Framework if you want to see how documentation should be done.

Guides and introduction : https://elixir-lang.org/getting-started/introduction.html

Elixir reference doc: https://hexdocs.pm/elixir/Map.html

Phoenix reference doc: https://hexdocs.pm/phoenix/Phoenix.Controller.html



Big +1. Those docs are a big reason I found Phoenix to be so fun -- all my beginner questions were stupid easy to answer, and my more intermediate questions had guides and links to further study in the official docs.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: