Extending the documentation

Last updated: 2026-05-26

Prerequisites

The documention used quarto and .qmd quarto markdown (a superset of markdown).

Configuration

The configuration for the static documentation site is defined in doc/_quarto.yaml.

Creating or modifying parts of the documentation

All documents are stored in .qmd format in doc/. Creation or modification of the documentation does not require local installation of quarto but can be done in any text editor or IDE. There are quarto plugins for VSCode and JupyterLab

Once finished, open a pull request to the dev branch. This will trigger the build_quarto_docs.yaml workflow which renders the site, updates last-modified dates from git history, and deploys to Cloudflare Pages on merge. To preview locally:

quarto render doc/
quarto preview doc/