How to edit documentation

Local development and preview

To preview docs locally, create a local Python environment and install dependencies, then make the docs.

virtualenv env
. env/bin/activate
pip install -r dev-requirements.txt
cd help
make html

Structure

We follow a conceptual framework called Diátaxis. For a primer, watch this video.