Contributing

About the documentation

The documentation is generated by mkdocs and mkdocs-material using GitHub Actions. They use markdown for composition.

Making Local Changes

If you are using the devcontainer-based setup, you have everything you need. If you are running locally, and you have Python installed, you should run:

$ pip install -r requirements.txt

Then you can run:

$ mkdocs serve

To see your documentation changes locally.

Deployment

Deployment is handled by our GitHub Action, so once you make a pull request to the repository and it is merged, the documentation will be updated.