CONTRIBUTING.md

Contributing

This document describes how to build the documentation yourself using MkDocs.

Set up project

1. Fork the GitHub project and create a local working copy.
2. Install uv.
3. Open a terminal, cd into the working copy you just created and run:

   sh scripts/set_up_project.sh

Working with the project

To build the documentation, run:

sh scripts/build_guide.sh

To browse the local copy, run:

sh scripts/serve_guide.sh

Adding and changing documents

Refer to the MkDocs user guide.