ExDoc has a cool new feature, Cheatsheets!
In this blog post, we'll explain what that new feature is and the motivation behind it. We'll also take the opportunity to highlight other ExDoc features that show how it has been evolving to make the documentation experience in Elixir better and better.
What is ExDoc Cheatsheet and how it improves documentation experience
ExDoc's Cheatsheets are Markdown files with the .cheatmd extension. One can use it to write cheatsheets about their Elixir project.
Writing and reading cheatsheets is not exactly a new thing for developers. But, what that feature brings as a novelty is a possibility of integrating a cheatsheet alongside the rest of the documentation of an Elixir project instead of hosting it in a different place.
Developers need different kinds of docs at different times. When one is learning about a new library, a guide format is proper. When one needs to know if a library can solve a specific problem, an API reference can be more appropriate. When someone wants to remember a couple of functions they already used from that library, a cheatsheet could be more practical.