Skip to content

Workflows

The current standard local review command for this repo is:

mkdocs-oves-krr --port 8017 --project-root D:\github\consolidated-docs

Maintain Curation

  1. Review candidate repos with python scripts/curation_inventory.py
  2. Update curation/curated-doc-sites.yml
  3. Regenerate hub content with python d:\github\generate-consolidated-docs.py
  4. Rebuild the hub with mkdocs-oves-krr --port 8017 --project-root D:\github\consolidated-docs
  5. Verify the hub output or live review target on port 8017

Promote Child Repo Changes Into The Hub

  1. Run mkdocs-oves-update-global-index from the child repo
  2. Verify the repo is already curated
  3. Refresh hub source content from the curated manifest
  4. Rebuild consolidated-docs on port 8017 to regenerate the committed global index
  5. Commit refreshed artifacts when the hub search corpus changed

Run Local Global Search Service

  1. Build the registry with python scripts/build_docs_search_registry.py
  2. Start the API with python -m uvicorn docs_search.app:app --host 127.0.0.1 --port 8105
  3. Choose DOCS_SEARCH_ENV=local or DOCS_SEARCH_ENV=cloud

Repo Identity And Naming

  1. Treat Doc Hub as the user-facing product name
  2. Treat consolidated-docs as the current repo id, local folder name, and /internal/consolidated-docs/ path contract
  3. Do not change repo/path identifiers casually, because scripts and search artifacts still depend on them