Skip to content

Doc Contribution

  • Clone the repo. You should be in the root folder containing ‘docs’, ‘mkdocs.yml’ config file, and ‘docs.yml’ github actions file.

  • Install dev dependencies (includes mkdocs deps):

pip install -e .[dev]
  • Serve the website locally
make docs-serve

you should see the website on your localhost port now.

  • Modify or create markdown files
  • modify / create your markdown files in ‘docs’ folder.
  • add your markdown path in the ‘nav’ section of ‘mkdocs.yml’.

Example folder-yml correspondence:

docs yml

  • Commit and push your changes to remote repo. Github actions will automatically push your changes to your github pages website.

Last update: February 28, 2023
Created: February 28, 2023