Skip to content

Contributing

Contributing to the Docs

Docs are built with MKDocs for Material

Please refer to the docs README for instructions on how to build and serve the docs locally.

Open your browser and navigate to http://yourserverip:8005

Add/edit markdown files in the docs/docs folder and you'll see live changes at the url above.

Edit docs/mkdocs.yml to edit structure and add new files.

Full MKDocs documentation here

Once finished, create a pull request to the main branch for review.