docs(readme): state the goal — one question, one complete answer, and the two stair-steps toward it - #88
Merged
Conversation
… the two stair-steps toward it The page said what ripwire does and never said what it is FOR. This is the objective in a reader's terms rather than a maintainer's: terminality, and the two properties that make it reachable in practice. Deliberately not written as a hard cap. An earlier draft said "answers are bounded, so a complete answer cannot cost you the context it was supposed to protect", which is false by the tool's own design — METHODOLOGY §9 principle 2 exceeds the ceiling with over_ceiling="1" rather than drop the row that would have terminated the search. A hard-cap claim would also undercut the terminality paragraph directly above it. It now reads as a budget you ask for with disclosed overshoot, which is both true and the stronger form of the point. Two other claims pulled back to what is actually true: "an answer never looks more complete than it is" rather than "never a confident wrong one" (the honesty attributes stop an answer OVERSTATING itself; they do not make the resolver infallible — amb="K" exists to disclose exactly that), and "an answer CAN be given a token budget" rather than every answer being bounded, since cli.h's flag table carries honorsMaxTokens per verb. No counts, no flag names, no published number — nothing here collides with the delivery queue's count sites or the absorb line. Sequenced to land AFTER PR #77 (issue #61): the overshoot sentence is the contract, over_ceiling ships, and #61 is an open bug against that contract on the --for --detail path. Landing the claim after the fix rather than before it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: 📒 Files selected for processing (1)
Cache: Disabled due to data retention organization setting Knowledge base: Disabled due to 📝 SummarySummary by CodeRabbit
WalkthroughREADME.md adds a section that defines the goal of answering one codebase question in one call. It documents floor counts, disclosed truncations, and token-budget reporting. ChangesAnswer documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: ✨ Finishing Touches🧪 Generate unit tests (beta)
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
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.
The page said what ripwire does and never said what it is for. This is the objective in a reader's terms rather than a maintainer's — terminality, and the two properties that make it reachable in practice — placed above the fold, after the pitch and before the lineage block.
Deliberately not written as a hard cap. An earlier draft said "answers are bounded, so a complete answer cannot cost you the context it was supposed to protect", which is false by the tool's own design:
docs/METHODOLOGY.md§9 principle 2 exceeds the ceiling withover_ceiling="1"rather than drop the row that would have terminated the search. A hard-cap claim would also have undercut the terminality paragraph directly above it. It reads instead as a budget you ask for with disclosed overshoot — true, and the stronger form of the point.Two other claims pulled back to what is actually true. "An answer never looks more complete than it is" rather than "never a confident wrong one" — the honesty attributes stop an answer overstating itself; they do not make the resolver infallible, which is what
amb="K"exists to disclose. And "an answer can be given a token budget" rather than every answer being bounded, since the flag table carrieshonorsMaxTokensper verb.Sequenced behind #61. The overshoot sentence is the contract and
over_ceilingships, but #61 was an open bug against that contract on the--for --detailpath —max_tokenswas named and applied to the bodies only. This lane was held until #77 landed and #61 closed, so the claim is true of the shipped tool rather than aspirational.No counts, no flag names, no published number — nothing here collides with a gate-count site or the absorb line.
CI: run 34413952370 — 26/26 green on
86612185.🤖 Generated with Claude Code