Docs index: complete, dated, and self-enforcing#150
Merged
Conversation
- docs/README.md: add an 'Updated' column (git last-commit date per doc) and a currency stamp; add the previously-missing EVAL_V1_24_0 entry so every doc under docs/ is mapped. - Add tests/test_docs_index.py: fail CI if a top-level doc is missing from the index or an index link does not resolve, so the map and tree cannot drift. - docs/INTERNALS.md: reconcile with the code and ARCHITECTURE.md - refinement threshold default is 70 (config GRADE_THRESHOLD_FOR_RESEARCH_REFINEMENT), and section writing uses gemini-3.1-pro-preview via previous_interaction_id (SECTION_WRITING_MODEL = PRO_MODEL), not gemini-3-flash-preview.
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
1 participant
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.
Follow-up to the 1.37.1 docs pass. Makes the documentation map (
docs/README.md) authoritative and keeps it from drifting, and clears the last inconsistency flagged in the audit.Changes
Index is now complete and dated. Added an
Updatedcolumn (each doc's last-commit date) and a currency stamp ("reviewed against primr 1.37.1"). Added the previously-missingEVAL_V1_24_0entry — every.mdunderdocs/is now mapped.Index can't silently drift. New
tests/test_docs_index.pyfails CI if a top-level doc is missing from the map or an index link doesn't resolve. It deliberately does not assert the informational date column (brittle under shallow CI checkout / squash merges) — it guards coverage and link validity, which are what actually rot.Resolved the INTERNALS ↔ ARCHITECTURE drift the audit flagged, against the code as source of truth:
config.GRADE_THRESHOLD_FOR_RESEARCH_REFINEMENT = 70), not 80.gemini-3.1-pro-previewviaprevious_interaction_id(SECTION_WRITING_MODEL = PRO_MODEL;deep_research.pywrites sections statefully), notgemini-3-flash-preview. Removed the stale "Why Notprevious_interaction_id?" subsection that argued against what the pipeline now does.Verified
tests/test_docs_index.py— 2 passed.mkdocs build --strict— clean (no broken links / nav gaps).