docs(readme): de-slop and tighten the README - #27
Merged
Conversation
…nhancements] Cuts marketing/AI-tell language (moat, load-bearing, verification arm, over-bolding, filler intensifiers) and the heavy repetition across the intro, boundary, coverage, and origin sections. Folds the boundary into How it works; merges the two coverage sections. Aligns structure and voice with the rac-core README. Fixes staleness: leads with 'npm i -g @itsthelore/proofkeeper' (published) instead of clone-and-build, drops the 'v0.0.1 prototype' status for the CalVer/npm reality, and corrects the repository-layout tree. Signed-off-by: Tom Ballard <tom@armytage.co>
…us-qa-enhancements]
Copywriting pass to avoid overclaiming: reframe 'proves it does' to 'shows it does' with the test as the proof/evidence (a passing test is not a correctness guarantee); qualify 'any OpenAI-compatible provider' as endpoints that support tool calls (the drive depends on them); replace the 'like a developer would' simile with concrete verbs; drop filler ('the artifact is the point', 'a real test').
Signed-off-by: Tom Ballard <tom@armytage.co>
…s-qa-enhancements] Clarifies that the model is used only during the drive; the compiled Playwright test, the fidelity re-runs, and every later run need no model or key. Preempts the cost/flakiness objection and states the actual boundary. Signed-off-by: Tom Ballard <tom@armytage.co>
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.
A critical pass over the README: cut AI/marketing language, remove repetition, tighten to match rac-core's structure and voice, and fix a few stale facts. 260 → 182 lines.
Cut (the slop)
Structure (align with rac-core)
ModelClientcode block into one line pointing at the library API.Fixed (staleness, while here)
npm i -g @itsthelore/proofkeeper(it's published) instead ofnpm install && npm run build(clone-and-build).proofkeeper/, notlore-proofkeeper/twice).Kept intentionally
No code or behaviour change — docs only.