Docs Scripts

Contributing

For contribution workflow, PR release-note expectations, and release-label policy, see Contributing Guide.

Doc'ing the docs, very meta. This is just a run-through of how to build the documentation.

To generate updated docs from the scripts below, make sure the dev server is running pnpm dev, then just run pnpm docs:build.

Screenshots

Setup

1. At the project root, create a virtual environment: virtualenv .venv
2. Activate it source .venv/bin/activate
3. Install the packages pip install -r docs/scripts/docs-requirements.txt
4. Make sure the .env file ORIGIN is set to the same URL as the demo server.

Running the script

1. Get the demo server running pnpm dev

2. In a separate shell to the server, run the screenshot generation: pnpm docs:screen

3. Any new pages you wish to scrape can be added to the above script inside the Python dict PAGES_TO_CAPTURE

4. Files are currently exported to docs/images

JSDocs Generate

1. Run pnpm docs:jsdocs

MkDocs Site

1. Install MkDocs dependencies: pip install -r docs/requirements.txt
2. Build or serve the docs with the config: mkdocs build -f docs/mkdocs.yml or mkdocs serve -f docs/mkdocs.yml