docs: #1075 tranche-2 doc-file audit — 24 fixes across 16 files - #1088
Conversation
There was a problem hiding this comment.
Sorry @robotrocketscience, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
Important Review skippedIgnore keyword(s) in the title. ⛔ Ignored keywords (2)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
PR-size soft capThis PR is over the advisory size threshold:
Bigger PRs collide with more open work, which under the parallel-session workflow tends to produce repeated This is advisory only — nothing is blocked. If the size is intentional (large refactor, module removal, generated code), apply the |
|
merge-train: blocked branch is not fast-forward on The |
c6fb91d to
40ecfbe
Compare
|
merge-train: merged 40ecfbe → |
Completes tranche 2 of the #1075 v4.0.0 documentation-audit release gate: the remaining doc-file buckets deferred by the doc-file-surface pass (
DOCS-AUDIT-2026-07-04.md) and the two in-code ledgers (-incode.md,-tests-bench.md).Refs #1075 — does NOT close it. The umbrella stays open until the v4.0.0 tag; this PR lands the last documentation tranche, leaving only the release cut.
What this is
An 8-batch multi-agent audit of all 95 remaining doc files at HEAD
13f7d0b4:CHANGELOG.md+CHANGELOG/v0–v3.md(verified against code at the corresponding tags),docs/design/*(58 current + 13historical/),docs/adr/*,docs/experiments/*, priordocs/audits/*snapshots,tests/READMEs,.github/pull_request_template.md,CITATION.cff. Every doc-bearing line read and checked; each HIGH independently re-verified and every refreshed source line-pointer re-grepped at HEAD before landing. Doc-text only; no code behavior changed. One atomic signed commit per file.Ledger:
docs/audits/DOCS-AUDIT-2026-07-04-docfiles.md(fourth and final companion to the doc-file,src/in-code, and tests/bench in-code ledgers).Coverage & tally
The two HIGHs
docs/audits/README.mdomittedDOCS-AUDIT-2026-07-04-tests-bench.mdfrom the index (a present record missing from the index fails the coverage rule) → indexed.docs/design/context_rebuilder.mdstill documented the rebuilder as a PreCompact hook emittingadditionalContext; superseded by fix(hook): PreCompact rebuild block rejected by harness — move injection to SessionStart(source=compact) #1031 (nowsession_start(source=="compact")) → delivery-channel banner added, design narrative +rebuild_v14path unchanged.Recurring drift fixed
#1031 PreCompact→SessionStart(compact) move (
context_rebuilder,relevance-signal) · under-doc'd post-ship additions (claude_memory7th ingest source kind in the replay-soak corpus;expand_bfssymbol;BFS_EDGE_WEIGHTSmodule location) · stale[Unreleased]compare link (v3.7.0→v3.8.0) · a danglingdocs/no_embeddings_first.mdlink →PHILOSOPHY.md·CITATION.cffmissingversion/date-released· source line-pointer drift (dropped to symbol names where purely positional).Frozen snapshots (
historical/, ADRs, prior audits) corrected via banner/annotation only, never body rewrites. Per-file commits let each correction be reviewed and reverted independently.After this tranche
Only the v4.0.0 release cut to PyPI remains on #1075.