Guides · v1

Keeping the reference current

Reference 2026-11-10.1 · Reviewed 2026-11-10

Reference revision 2026-11-10.1 was reviewed on 2026-11-10. Documentation updates are part of each API change.

1. Update the contract, field descriptions, permissions, examples and limitations together with the implementation.
2. Run the application contract checks and the public documentation checks. They compare REST routes/scopes, MCP tool definitions, schemas and examples.
3. Record the change and review date in the changelog, then publish only the reviewed public export.
4. Verify the published documentation and discovery routes against the generated files.

Automated checks

The public repository workflow validates the reference and builds every page on pushes and pull requests. Application tests separately compare the implementation with packaged contracts. These checks detect omissions and contract drift; human review is still needed for the accuracy of explanations and production readiness.

Publication and provenance

The checks do not automatically release backend features or publish the website. Publication follows the existing reviewed release process. The public documentation version record includes the review date and a SHA-256 fingerprint of the contracts and guidance used for this build.

Contributor update checklist · Dated changelog · Machine-readable guidance