docs: extract the invariant register (planning/invariants.md) - #64
Merged
Conversation
Step one of the docs-curation round: reconcile the invariants scattered across CLAUDE.md, the README, and planning/ into one crisp, normative, citable-by-id register (S/W/L/G/M/E sections), verified against the code and recent history rather than doc text alone. Contentions found during extraction are flagged inline (projection formulation Markdown-vs-vault-directory; the write-surface enumeration, including a documented 'alias refresh' no code performs), and a drift log lists stale text to reconcile next (sqlite-vec references, inline-wins dedup, the 10-verb vocabulary, the 'updated' claim, a stale log-tier code comment, README/tasks focus mismatch). The reviewed docs now each carry a one-line pointer to the register. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014nqUJPkUcLHphnuKYhSHMy
Resolve the two flagged contentions: the projection invariant is index = projection of (the vault directory), with Markdown the sole authored subset (S2), and B2's write surface is one unbidden write plus enumerated command mechanics — the never-built 'cosmetic alias refresh' is dropped everywhere (W3). The register's contention flags and drift log are removed accordingly. Sweep the reviewed docs to describe the present system only, leaving evolution to git history: frontmatter-wins dedup and the two-home graph replace the superseded inline-wins/three-home text; the stance-trio vocabulary replaces 10-verb mentions; sqlite-vec references become the in-process plain-table scan (B2-side only; qmd descriptions stay); resolved open questions, supersession callouts, and reversal parentheticals are deleted; data-model's judgment-call digest is restated in current terms; 'updated:' is documented as not B2-stamped; the README points at the actual current focus; and a stale log-tier code comment in ingest.rs is corrected. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014nqUJPkUcLHphnuKYhSHMy
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (9)
📝 WalkthroughWalkthroughThe PR aligns repository guidance and planning documents with a two-tier vault/disposable-index architecture, adds a normative invariants register, replaces ChangesArchitecture documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested reviewers: Poem
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
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
2 participants
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.
Step one of the docs-curation round: reconcile the invariants scattered
across CLAUDE.md, the README, and planning/ into one crisp, normative,
citable-by-id register (S/W/L/G/M/E sections), verified against the code
and recent history rather than doc text alone.
Contentions found during extraction are flagged inline (projection
formulation Markdown-vs-vault-directory; the write-surface enumeration,
including a documented 'alias refresh' no code performs), and a drift
log lists stale text to reconcile next (sqlite-vec references,
inline-wins dedup, the 10-verb vocabulary, the 'updated' claim, a stale
log-tier code comment, README/tasks focus mismatch).
The reviewed docs now each carry a one-line pointer to the register.
Co-Authored-By: Claude Fable 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_014nqUJPkUcLHphnuKYhSHMy
Summary by CodeRabbit