title: Source of Truth description: The layered documentation model for ByteOr: central hub, repo-local canonical docs, and rustdoc.
Source of Truth
ByteOr uses a layered documentation model on purpose. Not every page belongs in the central site.
This page defines the documentation ownership model for the platform. It exists to prevent contract-level material from drifting into the public hub when the canonical source already lives in a repo docs tree or in rustdoc.
Layer 1: Repo-local canonical docs
Each repository owns its technical and operator source of truth under its local docs/ tree.
indexbus/docs/owns transport and substrate contracts.byteor/docs/owns the OSS execution and ABI contracts.byteor-enterprise/docs/owns enterprise runtime and operator contracts.byteor-cloud/docs/owns the hosted control-plane guide set.
These repo docs are the right place for low-level technical detail that changes with the code.
Layer 2: Same-site rustdoc
For Rust workspaces, rustdoc is the canonical API reference.
- It should answer crate, module, type, and function questions.
- It should not be duplicated by hand-authored prose pages in the central site.
Layer 3: Central public hub
This site exists to provide:
- product framing
- onboarding paths
- cross-repo navigation
- high-level conceptual explanations
- stable entry points into the canonical repo docs and rustdoc
Manifest-driven synced pages under Synced Repo Docs are generated from each repo's docs/public-docs.json and published inside this central Rspress site. They are generated copies of repo-owned source, not an independent editorial surface.
Practical rule
When a topic starts drifting into repo-specific low-level contract detail, link to the synced repo docs or rustdoc instead of duplicating it here.