Writing documentation¶

"Documentation is one of the foundational blocks for building a community." "Think of writing docs as writing code." -- Olga Merkulova in Write documentation that actually works for your community

We try to follow the Diátaxis principles. Diátaxis identifies four modes of documentation: tutorials, how-to guides, technical reference and explanation. Each of these modes (or types) answers to a different user need, fulfills a different purpose and requires a different approach to its creation.

Getting started with Sphinx
Building the Lino docs
Doctests in Lino
Types of documentation
Start your own developer blog
Where to put your docstrings
Help texts
About developer documentation
Shared Sphinx resources
Documenting changes
Redirected historic URLs
Shared documentation pages
About local help pages
Referring to other doctrees