TopoloDocs
Canonical documentation, system registry, and machine-readable launch evidence for the Topolo Platform.
What It Is
TopoloDocs is the canonical documentation and registry surface for the Topolo Platform. It publishes product documentation, internal system handbooks, system registry metadata, Auth catalog snapshots, and launch-readiness evidence.
Architecture
TopoloDocs builds from checked-in Markdown and JSON content. The docs validator confirms system coverage, Auth catalog snapshots, security-assurance metadata, data-privacy metadata, and registry/document consistency before deployments.
Runtime Surfaces
- public docs at
https://docs.topolo.app - staging docs at
https://docs.stg.topolo.us - system registry entries under
src/content/systems - generated machine output for system and security evidence
- Auth service manifest
srv_topolo_docs
API Reference
TopoloDocs exposes generated machine-readable system output under /machine/systems/:system.json and generated security/privacy evidence through the docs build output. The active source contract is the checked-in content and validation scripts rather than an OpenAPI file.
Auth and Permissions
Public docs are readable without application auth. Authoring, validation, and deployment are controlled through repository permissions, CloudControl deployment metadata, and the Auth service manifest srv_topolo_docs.
Data Ownership
TopoloDocs owns documentation content, system metadata, generated docs evidence, and validation output. It does not own product runtime data for the applications it documents.
Deployments
TopoloDocs deploys through the standard CloudControl-backed staging and production paths. Bare npm run deploy is disabled; use npm run deploy:staging or npm run deploy:production.
Failure Modes
- system registry drift from Auth service manifests
- launch-readiness evidence out of date with checked-in systems
- production or publication gates bypassed before docs validation
- generated machine output stale after catalog or registry changes
Debugging
Run npm run validate first, then run the relevant security/privacy gate profile. For service-registry issues, compare src/content/systems/*.json with PlatformApplications/TopoloAuth/catalog/service-manifests.
Change Log / Verification
- Added first-class TopoloDocs system coverage on 2026-05-11 so Auth catalog validation can verify the Docs service boundary.