Workflows¶
The current standard local review command for this repo is:
mkdocs-oves-krr --port 8017 --project-root D:\github\consolidated-docs
Maintain Curation¶
- Review candidate repos with
python scripts/curation_inventory.py - Update
curation/curated-doc-sites.yml - Regenerate hub content with
python d:\github\generate-consolidated-docs.py - Rebuild the hub with
mkdocs-oves-krr --port 8017 --project-root D:\github\consolidated-docs - Verify the hub output or live review target on port
8017
Promote Child Repo Changes Into The Hub¶
- Run
mkdocs-oves-update-global-indexfrom the child repo - Verify the repo is already curated
- Refresh hub source content from the curated manifest
- Rebuild
consolidated-docson port8017to regenerate the committed global index - Commit refreshed artifacts when the hub search corpus changed
Run Local Global Search Service¶
- Build the registry with
python scripts/build_docs_search_registry.py - Start the API with
python -m uvicorn docs_search.app:app --host 127.0.0.1 --port 8105 - Choose
DOCS_SEARCH_ENV=localorDOCS_SEARCH_ENV=cloud
Repo Identity And Naming¶
- Treat
Doc Hubas the user-facing product name - Treat
consolidated-docsas the current repo id, local folder name, and/internal/consolidated-docs/path contract - Do not change repo/path identifiers casually, because scripts and search artifacts still depend on them