With the release of ExDoc Cheatsheets, we thought it would be a good time to recap and show other 8 ExDoc features that make the documentation experience in Elixir such a joy: https://elixir-lang.org/blog/2022/12/22/cheatsheets-and-8-other-features-in-exdoc-that-improve-the-developer-experience/ (plus two bonus entries!)

By @hugobarauna! #MyElixirStatus
Cheatsheets and other 8 ExDoc features that improve the developer experience

This post explains the motivation behind the new ExDoc Cheatsheet feature. It also highlights other ExDoc features that show how ExDoc has been evolving to make the documentation experience in Elixir better and better.

The Elixir programming language

@josevalim @hugobarauna I am just experimenting with ways of writing architecture documents and tutorials differently at the mo and have just published this escript which is documented architecturally using itself

The thinking is that most documentation systems (like edoc) are how-to-use where the API is described and that you need a different style to describe how-it-works

Interested on any thoughts or comments

https://gordonguthrie.github.io/literatecodereader/

Architecture Of The Literate Code Reader Escript

a compiler for turning ordinary code into literate code for reading

literatecodereader
@josevalim @hugobarauna It works for Elixir/Erlang but I am (literally) just adding Super Collider (the synthesiser definition language) as I toot ;-)