Contribute and verify documentation

The package uses uv and Python 3.11–3.14. Clone the package repository, then:

uv sync --locked
uv run pytest
uv run ruff check src tests scripts examples
uv run python scripts/generate_assets.py --check
uv build

Read the package’s developer map for architecture, evidence contracts and algorithm details. The source package is MIT licensed, with bea-tools extraction attribution preserved.

Documentation site

Use the Node version in .nvmrc:

npm ci
npm run format
npm run validate
npm run develop

Validation checks formatting, code fences, site configuration, source metadata, Astro diagnostics, production output and internal links. Preserve the Clinical Slate styling and the getting-started, guides, concepts, reference and contributing navigation.

Keep visuals tied to code

Every package release regenerates availability, census, grain, path and topology images by executing examples through the package renderers. Copy the release’s generated asset archive into public/generated/ alongside corresponding content changes. Review the PNGs and offline HTML before committing. Do not hand-edit generated evidence or screenshots.

This site tracks GitHub’s latest stable release. Update every field in docs-source.json, affected content, installation instructions, and generated assets in the same reviewable pull request. Validate the site and review the Cloudflare preview before merging.