Process Publishing¶
Everything under docs/ publishes to the support microsite, in the private section.
Rules:
- Treat the docs/ tree as the canonical source.
- Publish the docs/ tree to the support microsite private section.
- Do not create a second source of truth while publishing.
- When adding, renaming, or moving a BFDev docs page, update mkdocs.yml and any relevant handbook or section index pages so the page is reachable in the published site.
- Treat broken navigation or orphaned pages as incomplete documentation work.
Actual publication behaviour:
- Maintainers publish locally with ./publish-docs, which builds the BFDev MkDocs site and stages the generated output into the checked-out bf-support-microsite repo under public/private/bf-dev/.
- BFDev CI owns the automated sync in the separate include file .gitlab/docs-publish.yml.
- The docs CI job runs only when BFDev docs publishing inputs change on the default branch.
- The automated job clones support-microsite, runs ./publish-docs, and pushes the updated generated docs when there is a diff.
- bf-support-microsite serves the published output; it is the serving target, not the canonical authored source.
- BFDev docs publication depends on CI credentials that can push to support-microsite.