Repository navigation
Open the README with benefits, real notices and badges - #22
Merged
Merged
Conversation
Visitors had to read a glossary before they saw what the extension does. The first screen now shows the promise, the install command, the benefits, and the exact notices that replace old content, under headings that use the search terms.
A fact-check found five overpromises in the new top section and a diagram that showed read replacement at every turn, although it happens only above the threshold.
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.
Why
The README is the landing page on GitHub and npm. Visitors had to read a glossary before they saw what the extension does and why it matters.
Changes
src/stale.ts:6,src/prune.ts:51andsrc/shake.ts:106. Sizes and IDs are marked as illustrative.<details>block. The three-item list under "The problem" is removed, because the benefits replace it.Verification
fa1f7e2:npm run checkpassed (102 tests). Documentation only.rgreturned nothing).fa1f7e2: recall covers the current branch, notices apply above the threshold, a ready note must still fit, compaction still summarizes older messages, and/compactfalls back to Pi's summary. The token ratio now cites Pi's 4-characters estimate. The diagram no longer shows read replacement before the threshold check, an older error that the check found. Still unverified: the Anthropic reasoning exception, which comes from the existing README and repo comments.<details>. npm shows the new text only after the next publication.Risk and rollback
Low: documentation only. Rollback: revert the squash commit. Owner: HugoLopes45.