Thank you for investing your time in contributing to our project!

Any contributions you make are governed by our License.

Please follow our Code of Conduct to keep our community approachable and respectable.

You could read the GitHub Docs Contributing Guide for general advice on how to contribute.

Since this is a small hobby project, your contribution may not be noticed for a while if we are busy elsewhere. Sorry!

MkDocs

This site is built with MkDocs.

That's a python tool. Python is managed with uv.

Run uv sync to install the dependencies.

Then:

• uv run publish_index.py - Sync over some files.
• uv run mkdocs serve - Start the live-reloading docs server.
• uv run mkdocs build - Build the documentation site.