Contributing

Read the contributing guide before opening a pull request.

Use GitHub Discussions for questions, ideas, and help requests. Use issues for confirmed bugs and focused feature requests.

Extending a fork

Where to Extend points to the code and checks for each kind of change. Read Backend layers and prompting for dependency rules, Secondary workflows for optional features, and Database init and upgrades before adding persisted fields.

Build the documentation locally

The wiki uses MkDocs Material. From the repository root:

pip install -r requirements-docs.txt
mkdocs serve

Open http://127.0.0.1:8000. MkDocs reloads pages as you edit them.

Run mkdocs build --strict before submitting; CI checks documentation changes with the same command.

Changes to docs/** and mkdocs.yml are deployed to GitHub Pages after they are merged into main.