Skip to content

Adding new docs coverage

Whenever you add a new public surface:

  • root export: update the relevant Python API/reference page
  • catalog export or catalog workflow: update the catalog-facing reference or benchmark docs and keep inventory coverage truthful
  • CLI command or subcommand: update CLI reference and inventory coverage
  • builtin component or benchmark entry: update the relevant catalog docs and keep the inventory script truthful
  • runtime topic with user-facing consequences: add or update the required topic markers enforced by docs tests
  • user-facing workflow: add or extend a runnable example and point a tutorial or guide at it when appropriate

Required local checks:

uv run pytest tests/test_docs_site.py tests/test_docs_examples.py tests/test_docs_inventory.py -q
uv run mkdocs build --strict