Docs Site Development (MkDocs)

This project uses MkDocs Material to publish the documentation website.

Run locally

pip install -r requirements-docs.txt
mkdocs serve

Open http://127.0.0.1:8000 to preview changes with live reload.

Build locally

mkdocs build --strict

--strict turns warnings into errors, which helps catch broken navigation or links before opening a PR.

Documentation standards

Every new technical page should follow this teaching pattern:

1. What it is
2. Why it matters
3. How it works
4. Concrete example
5. Common mistakes

For rubric quality guidance, use Educational Criteria Design.