How to contribute

Note

See CONTRIBUTING.md for information on contributing to the source code.

Our documentation is stored in the docs directory alongside the source code on GitHub. It is based on the Canonical starter pack and hosted on Read the Docs. In structuring, the documentation employs the Diátaxis approach.

You may open a pull request with your documentation changes, or you can file a bug to provide constructive feedback or suggestions.

For syntax help and guidelines, refer to the Canonical MyST style guide.

To run the documentation locally before submitting your changes:

cd docs
make run

Automatic checks

GitHub runs automatic checks on the documentation to verify spelling, validate links and style guide compliance.

You can (and should) run the same checks locally:

make spelling
make linkcheck
make vale