Maintain the documentation

This site documents the source state recorded in docs-source.json: a repository, a release label and an exact commit.

Synchronize with the source

1. Pick the commit to document and check it out.
2. Compare the pages with the code, not with older docs. The pages most likely to drift are:
   • CLI reference, against the Typer commands in src/dicom_kb/cli/;
   • MCP tools, against src/dicom_kb/mcp/;
   • Configuration, against config.py and cli/context.py;
   • Coverage and limits, against a fresh build and its gap log.
3. Rerun the examples in Answer DICOM questions against a build of the current NEMA edition and paste the real output.
4. Update every field of docs-source.json and any prose that repeats the release or commit, in the same pull request.

Writing rules

• Keep the five sections: Getting started, Guides, Concepts, Reference and Contributing. Add a page only for a distinct reader need.
• Fence code with an explicit language (bash, python, json, yaml, text). Keep $ prompts out of bash blocks and put output in a separate text block.
• Show short answers only. Never paste whole sections, tables or code lists from the standard.
• Keep the legal page’s non-affiliation, trademark, license-scope and no-certification language.

Validate

npm run format
npm run validate

Validation checks formatting, code fences, site configuration, the source pin, Astro diagnostics, the production build and internal links. CI runs the same checks on pull requests.