Docs

Documentation is managed with mkdocs.

Adding documentation

Edit the documentation in:

/docs

Edit the documentation nav in:

/mkdocs.yaml

Build and serve the documentation locally with:

mkdocs serve

Production documentation is built on merge into main with the Github Action:

/.github/workflows/docs.yml