Skip to content

Capabilities

This repo is the curation and cross-repo search authority for the human-facing Doc Hub. The product is branded as Doc Hub, but the current operational repo and canonical internal path are still consolidated-docs.

Context Services

Curated Site Inventory

  • source of truth: curation/curated-doc-sites.yml
  • purpose: identify which repos are intentionally included in the hub
  • typical question: "Is repo X curated right now?"

Curation Qualification

  • source of truth: README.md, scripts/curation_inventory.py
  • purpose: explain the quality gate for adding a repo to the hub
  • typical question: "What does a repo need before it can be curated?"

Hub Build Contract

  • source of truth: README.md, D:\github\generate-consolidated-docs.py
  • purpose: explain how curated metadata becomes hub navigation and index content
  • typical question: "What must be rebuilt after curation changes?"

Global Search Contract

  • source of truth: docs_search/, docs/assets/global-doc-search-index.json, config/docs-search-sites.json
  • purpose: explain the local-first search backend and committed cross-repo index
  • typical question: "How is cross-site search produced and served?"

Canonical Docs Path Resolution

  • source of truth: README.md, mkdocs.yml, config/docs-search-sites.json
  • purpose: explain /internal/<repo>/... path ownership and environment origin rules
  • typical question: "How should docs links differ between local and cloud?"

Hub Runtime And Review

  • source of truth: config/basic-doc-review-suite.json, local-serve-hub.json
  • purpose: define the standard local review command and default hub port
  • typical question: "How do I rebuild and review the hub locally?"