Deepen docs accuracy + repo-wide link guard#151
Merged
Conversation
…uard - Add tests/test_doc_links.py: every relative Markdown link in the repo (not just the index) must resolve, guarded in CI. - INTERNALS.md: correct the scraping internals that had drifted from code and ARCHITECTURE.md - 9-tier browser-first escalation (was 4-tier HTTP-first), the 5 real HTTP fingerprint profiles (was 4 with a nonexistent Firefox), 23 company-overview sections (was 21), single 0-100 grading score (was per-dimension 0-25), and the full strategies/ module listing. - Replace two deprecated Grok-4.1 model IDs presented as current: ARCHITECTURE XAI fallback -> grok-4.20-non-reasoning; EVAL judge example -> grok-4.3. - README: add Azure Foundry / AWS Bedrock provider keys and the keys-test note; surface the --acknowledge-host-agent-may-bill gate on the hybrid pilot row. Model IDs and cost figures were swept across all docs against config/models.py and cost_estimator.py; costs were already fully consistent.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Second consistency pass, going deeper than the top-level 1.37.1 sweep. Auditing was done against source (config/models.py, cost_estimator.py, tier_registry.py, profiles.py, company_overview.yaml) via parallel agents; fixes applied and verified.
Durability
tests/test_doc_links.py— every relative Markdown link in the repo (READMEs, guides, skills, design notes, examples), not just the doc index, must resolve or CI fails. Scanned 250 links; all resolve today, now permanently guarded.Accuracy — scraping internals in INTERNALS.md had drifted from the code
tier_registry.py), which also matches ARCHITECTURE.md.Accuracy — deprecated model IDs presented as current
grok-4.1 fast→grok-4.20-non-reasoning($2/$6, the realGROK_MODEL_WRITING).grok-4-1-fast-reasoning→grok-4.3.README polish
AZURE_OPENAI_API_KEY) and AWS Bedrock (AWS_BEARER_TOKEN_BEDROCK) to the keys table + aprimr keys testnote.--acknowledge-host-agent-may-billgate on the hybrid-pilot row.Swept and confirmed clean
docs/design/*: audited; the dated decision records are accurate to 1.37.1 — left as-is.Verified
tests/test_docs_index.py+tests/test_doc_links.pypass;mkdocs build --strictclean.