Documentation
This section provides contributor information both on creating documentation and publishing it to the docs website.
Documentation is written in Markdown and stored in the repo ./docs
folder.
The documentation is available publicly:
- on the GitHub repo (reflects latest commits)
- on the docs website (reflects capture of documentation most recently pushed to
gh_pages
branch)
We here provide guidance for
- updating documentation in the
./docs
folder - deploying documentation from the
./docs
folder to the docs website.