Documentation¶
This documentation lives in docs/ and is built with Zensical.
make docs-serve # live preview on http://localhost:8000
make docs-test # markdown lint, strict build and link check with a summary
make docs-screenshots # regenerate the screenshots with Cypress
| Path | Content |
|---|---|
docs/zensical.toml |
configuration and navigation |
docs/content/ |
the pages; new pages must be added to nav |
docs/content/images/screenshots/ |
screenshots made by make docs-screenshots, committed |
docs/Dockerfile |
nginx image serving the site built by CI |
docs/deploy/ |
values for the shared chart helm/static-website |
All tools run in Docker (python:3-slim for Zensical, davidanson/markdownlint-cli2, lycheeverse/lychee), so Docker is the only requirement. The changelog page includes CHANGELOG.md from the repository root, so it never needs to be copied.
Screenshots use invented people and clubs only. Update the documentation together with the feature it describes.