Skip to content

Developer Guide

Environment Setup

Besides the environment setup in Environment Setup, you need to install mkdocs-material for maintaining the documentation.

pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2

Documentation

Currently we maintain the deliverable documentation in docs folder. The documentation is built using MkDocs and Material for MkDocs, and each markdown file is a page in the documentation. Everytime a new commit is pushed to the main branch, the documentation will be automatically built and deployed to GitHub Pages.

How to add a new page?

  1. Create a new markdown file in the docs folder.
  2. Add the new page to the mkdocs.yml file under the nav section.

How to preview the documentation?

Run the following command in the root directory of the project:

mkdocs serve

Then you can preview the static sites in your browser.