Documentation¶
This section holds everything written down: guides, references, decisions and how-tos.
Sections¶
| Page | What it covers |
|---|---|
| Getting started | The shortest path from nothing to something working. |
| Editing this site | How to change these pages — including from a phone. |
| FAQ | Questions that come up more than once. |
How this documentation is organised¶
Each page answers one question and says so in its title. If a page starts answering a second question, it becomes two pages.
Adding a page
Create a Markdown file under docs/documentation/, then add it to the
nav: list in mkdocs.yml. Without the nav: entry the page still
builds, but nobody can find it.