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.)
Candidate guides to add, drawn from what consumers actually hit:
- Consume
altaforge-uias apnpmworkspace submodule (and thenpm-workspace caveats) — see the README. - Get the theme + stylesheet import order right so components render correctly.
- Cut a release (version bump → tag) — see the README.
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 → the component API is Storybook (
npm run storybook);docs/reference/explains how to reach it. Prose reference pages can live here too. - Explanation →
docs/explanation/— the why: design, rationale, standards.
Add the page to nav: in mkdocs.yml. Preview locally with mkdocs serve (deps in docs/requirements.txt).