Building the Docs¶
The docs are Markdown files in docs/, built into a website with MkDocs Material. They are published at docs.mastura.org with tools/demo/deploy-docs.sh, and each push to main checks that they build.
Preview locally¶
pip install -r docs/requirements.txt
mkdocs serve
Open http://127.0.0.1:8000. The page reloads as you edit.
The API reference is generated¶
docs/developers/api-reference.md is written by go run ./tools/apidocs from the apiEndpoint lists in the code. Don't edit it by hand. The docs build fails if it's out of date.
Style¶
- Plain words and short sentences.
- Title Case for page titles and headings.
- Name what the user sees: menu, page and button names in bold.