Repository Docs
Library centralizes docs discovery, but source-of-truth technical docs should stay colocated with code in owning repos.
Import model
- Library CI scans submodules for
mkdocs.ymlfiles. - For selected repos, Library imports their
navtree and docs content into the combined docs build. - This keeps authoring close to code while still publishing a single docs site.
Initial rollout
cloud_control_planeis the first imported repo.- Additional repos can be enabled by updating the import selection in
.github/workflows/docs-deploy.yml.
Cloud Control Plane imported docs
- Imported docs are shown under the generated nav section:
Repository Docs (From Submodules). - Source path prefix used by Library imports:
repo-docs/cloud_control_plane/source/.
Notes
- Imported content is generated during CI and is not manually edited inside Library.
- Update docs in the owning repo, then bump the submodule pointer in Library.