How-to guides¶
Task-oriented recipes — "how do I do X?" Each guide assumes you already know the basics and want to get one thing done.
(No how-to guides yet.)
Adding a docs page (the standard)¶
- Tutorial →
docs/tutorials/— teaches a beginner by doing. - How-to →
docs/how-to/— steps to accomplish one task. - Reference →
docs/reference/— exact API; prefer::: altaforge.<module>(mkdocstrings pulls the reST docstrings from source, so it never drifts). - Explanation →
docs/explanation/— the why: design, rationale, standards. - Design spec →
docs/specs/— a dated, point-in-time design record.
Add the page to nav: in mkdocs.yml. Preview locally with mkdocs serve (deps in docs/requirements.txt).