Documentation status¶
This page separates automated guarantees and completed technical drills from human or environment-specific validation. The status was last reviewed on 2026-07-23.
Verified gates¶
| Gate | Evidence |
|---|---|
| English and Russian maintained pages stay paired | make docs-quality checks every page under User, Admin, Reference, and Operator, plus both home pages. |
| Public and protected sites build with strict link validation | MkDocs strict builds run locally and in the docs CI job. |
| Operator procedures stay out of the public site | The quality gate checks the generated public tree and every public HTML link. The internal build must contain both English and Russian Operator indexes. |
| Product help links stay public, bilingual, and audience-mapped | The quality gate validates DOCS_PATHS and DOCS_AUDIENCES; web tests verify URL and locale behavior. |
| The published REST reference is read-only | The generated artifact contains exactly 11 allowlisted GET operations. The build rejects forbidden endpoint families or a stale copied artifact. |
| A clean environment can be bootstrapped | The protected environment-bootstrap smoke test was completed on 2026-07-23 with isolated state and a new sign-in. |
| Stateful backup and restore works as documented | The protected multi-store restore drill was completed on 2026-07-23 for PostgreSQL, Temporal, Qdrant, MinIO, Redis, and Phoenix state. |
| Documentation changes have a review contract | CONTRIBUTING.md and the default merge request template require documentation impact and explicit unverified boundaries. |
Run the complete local gate from the repository root:
make docs-quality
Preview the public portal with make docs-serve. Authorized maintainers can
preview the Operator build separately with make docs-serve-internal.
Not yet independently verified¶
The following gates require people, shared infrastructure, or external providers. Automated checks do not claim they are complete:
- a new user who did not help write the documentation completing the usability walkthrough;
- a full MVP walkthrough by a reviewer uninvolved in implementation;
- deployment on shared staging with real DNS, TLS, reverse proxy, and provider callback configuration;
- a complete administrator launch-stack journey covering invitation, connector setup, first sync, approval policy, and audit verification.
Record dated evidence and discovered blockers here when each walkthrough is completed. Do not replace a human or staging result with a local build result.