Repository navigation
docs(020): make the README accurate and stop checking prose documents from RSpec - #72
Merged
Merged
Conversation
The maintainer's ruling of 2026-10-12: spec, plan and implementation reviews run on Opus by default; Fable only when named for a review. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
From issue #63. The maintainer widened it to the whole README, with a pre-1.0 sentence that links the roadmap and a hand check on record. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maintainer ruling: the 'public card search proof-of-concept' phrase in CLAUDE.md's Project Status is corrected in this PR (decision 4, AC-2.9, FR-4). The rest of CLAUDE.md is not swept. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Mode A, NEEDS REVISION, three blocking. spec/readme_spec.rb already pins README phrases and stays; claims may be left stale with a recorded reason; gaps are recorded and no issue is opened. Adds sorting rules for claims and proposes decision 5 (CLAUDE.md gets the corrections it repeats), for the maintainer's ruling. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maintainer rulings of 2026-10-12: spec/readme_spec.rb is removed in this PR (Story 4, FR-5), keeping its two configuration expectations in spec/image_publishing_spec.rb; CLAUDE.md gets the README corrections it repeats. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Opus, Mode A, second pass: two blocking, wording only. Two examples move to spec/image_publishing_spec.rb with stated counts; 'not refuted' is a result, not a kind of claim; comparisons use origin/main...HEAD; the CLAUDE.md sentence is given verbatim. Approved by the maintainer. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maintainer ruling of 2026-10-12, made while planning: no RSpec example checks a prose document (decision 7). Besides spec/readme_spec.rb, the releasing, design-system, CLAUDE.md, skill and ADR-index examples go. The export format's checks, configuration checks and code checks stay. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Opus, Mode A, on the 1.4.0 change: READY TO PLAN, nothing blocking. A prose document is defined by who reads it; AC-4.6 uses a wider search; the PR description names the second outcome. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Five phases: remove the prose-document checks, rewrite the introduction, make the known corrections, sweep the README section by section, and record it. The spec-file edits were run on scratch copies first. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Opus, read-only, NEEDS REVISION, nothing blocking. Searches now exclude .kamal/secrets and documents; the example count and safety-warning checks are corrected; two diff hunks get their context lines back; the action table gains three rows; four ordering slips are fixed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Opus, read-only, READY TO EXECUTE, nothing blocking. The OCR route and safety-warning checks are corrected, the record separates claims from claims checked, the session wrap runs before the last file check, and the wait for rulings is spelled out. The spec notes the wrap's lessons. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Approved by the maintainer after two read-only Opus reviews. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…publishing spec Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Spec 020, decision 3: the maintainer doesn't want a spec of a README's wording. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refs #63 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maintainer ruling of 2026-10-12 (spec 020). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maintainer ruling of 2026-10-12 (spec 020). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…work upgrade Maintainer ruling of 2026-10-12 (spec 020); found by the implementation review. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maintainer ruling of 2026-10-12 (spec 020); found by the implementation review. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…es it Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.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
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.
Closes #63
What this does
The README says what Collector is today. Its first paragraph said "Accounts and collections are not built yet" and called catalog search "public". It now describes accounts, the collection, catalog search, the card scanner and the admin pages, says Collector is pre-1.0 and links the roadmap.
Every checkable claim in the README was checked against the repository. The maintainer widened issue #63 from the introduction to the whole file. Of 372 claims in 15 sections: 309 true, 23 not refuted, 5 corrected, 1 left as it is by ruling, 32 not checkable (sizes, durations, other tools' behaviour), 2 off-limits (
.kamal/secrets). The record is inverification.md.Corrections outside the introduction:
spec/requests/health_check_spec.rb:5), in the README and inCLAUDE.md.COLLECTOR_PASSWORDis removed from the Compose variable table:compose.yamldoesn't pass it to the container. The Accounts section still shows the workingdocker compose exec -ecommand.CLAUDE.md's Project Status no longer calls the card search a "public … proof-of-concept"; it says search has needed sign-in since accounts.A second outcome: the suite checks no prose document (decision 7)
By the maintainer's ruling, made while this spec was being written, RSpec no longer checks prose documents (
README.md,CLAUDE.md, files under.claude/, Markdown and reference files underdocs/). The spec rules would have split this into its own spec; the maintainer ruled it into this PR.spec/readme_spec.rbis deleted (8 examples). Its two expectations aboutcompose.yamlandconfig/deploy.ymlare kept as two new examples inspec/image_publishing_spec.rb, each shown to fail first.docs/releasing.mdexamples, the design system's document examples and itsCLAUDE.mdand skill-file expectations, and the README-link and ADR-index examples of the export format's document spec..claude/rules/testing.mdgains the rule.The suite goes from 1,219 to 1,206 examples (15 removed, 2 added).
Rulings made during the sweep
COLLECTOR_PASSWORDin the Compose tableVerification
bin/cipasses atac13459(the only commits after it change the record): 1,206 examples, 0 failures, 1 pending (the existingart_agreement_spec.rbexample)..kamal/secretsreads. Agents may not read that file.Gaps the sweep noticed and did not fill (no issue opened; they are listed in the record for the maintainer to decide): the README has no "Using Collector" section, and fourteen smaller ones.
🤖 Generated with Claude Code