Skip to content

Contracts

Identity Contract

  • Doc Hub is acceptable user-facing terminology
  • consolidated-docs remains the operational repo id in source, scripts, and generated artifacts
  • /internal/consolidated-docs/ remains the current canonical internal route unless a coordinated migration is performed

Curation Contract

  • curated membership is explicit, not auto-discovered
  • curation/curated-doc-sites.yml is the curation authority
  • child repos are expected to meet the documented template and metadata checks

Search Contract

  • native child-site search indexes feed the cross-repo search corpus
  • the curated global search index is built locally and committed
  • config/docs-search-sites.json and docs/assets/global-doc-search-index.json must agree on repo/path identity
  • cloud deployment serves committed artifacts and environment-specific origin logic

URL Contract

  • canonical docs paths use /internal/<repo>/...
  • this repo currently owns /internal/consolidated-docs/...
  • committed content must not contain localhost
  • local proxy or environment assets provide runtime origin resolution