4 ms·
Generally speaking, Elixir. Documentation is written in the language itself, it is easy to create, and is very well written. As the authors themselves are the f
by kamma4434 2y ago
Generally speaking, Elixir. Documentation is written in the language itself, it is easy to create, and is very well written. As the authors themselves are the first users of the documentation facilities, they are very well done and maintained.
This in turn means that the structure and style is shared by many libs in the ecosystem, and everything is natively cross-referenced.
- kamma4434 2y agoSee https://hexdocs.pm/ https://hexdocs.pm/ - search for anything and click on the links. Documentation facilities in Elixir are extremely powerful, as you can use Elixir to generate the documentation itself! See e.g. the way UML diagrams are embedded here: https://hexdocs.pm/say_cheez_ex/readme.html#uml-dot-graphs https://hexdocs.pm/say_cheez_ex/readme.html#uml-dot-graphs - nothing stops you from creating them dynamically based on external information, test results, external services or whatnot.