fix(docs): correct beads-rust reference + stale "SQLite data model" claim#16
Merged
Merged
Conversation
…model" claim Two accuracy fixes (no behaviour change): - The board IS a projection over beads (store.py only shells `br` — no separate store; beads owns the .beads/*.db + JSONL), but __init__.py's module docstring still called it "a SQLite data model" — a leftover from before the beads migration (D8) that directly contradicted store.py. Fixed to say projection-over-beads. - The dependency is **beads-rust** (`br`, crate `beads_rust`), NOT the stale write-broken homebrew `bd`. The README linked the wrong repo (steveyegge/beads); point it at Dicklesworthstone/beads_rust + `cargo install beads_rust`, warn off `bd`, and make the store's not-on-PATH error say the same. The code was already correct (BR defaults to `br`, BR_BIN override); this only fixes docs + one error message. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
👀 Quinn is reviewing — verdict (PASS / WARN / FAIL) + findings to follow. |
![protoquinn[bot]](https://avatars.githubusercontent.com/in/3282126?s=60&v=4){kind=small}
There was a problem hiding this comment.
QA Audit — PR #16 | fix(docs): correct beads-rust reference + stale "SQLite data model" claim
VERDICT: PASS (pending CI) — non-blocking comment; CI still queued.
CI Status
- test: queued
Diff Review
- README:
steveyegge/beads→Dicklesworthstone/beads_rustwith install command +bdwarning. Correct — the code defaultsBRtobr(beads-rust), not the stale homebrewbd. __init__.py: "SQLite data model" → "projection over beads (br)". Accurate —store.pyshellsbr; beads owns.beads/*.db+ JSONL.store.py: error message now says "beads-rust" and warns offbd. Consistent with README.
Observations
- LOW: CI still queued at review time; re-dispatch will submit the formal APPROVED once terminal-green.
- All changes are docs + error-string only; zero behavioral risk. 3 files, ~25 net lines, no security paths.
— Quinn, QA Engineer
|
Submitted COMMENT review on |
Merged
protoquinn Bot
pushed a commit
that referenced
this pull request
Jun 13, 2026
Docs/accuracy patch over v0.4.0 (#16): correct the board's projection-over-beads docstring (was a stale "SQLite data model" claim) and the beads-rust reference (real repo Dicklesworthstone/beads_rust + `cargo install beads_rust`; warn off the homebrew `bd`). No behaviour change. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
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.
Two accuracy fixes (no behaviour change), both spotted in review:
store.pyhas no separate store (every op shellsbr; beads owns.beads/*.db+ JSONL), yet__init__.pystill called the board "a SQLite data model" (pre-beads-migration leftover, contradictingstore.py). Fixed.br), not the homebrewbd. The code was already correct (BRdefaults tobr), but the README linked the wrong repo (steveyegge/beads). Now points atDicklesworthstone/beads_rust+cargo install beads_rust, warns off the stale write-brokenbd, and the store's not-on-PATH error says the same.Docs + one error message only. 116 tests green, ruff clean.