docs(uncheck): rewrite the README to be shorter, friendlier and interactive first - #23
Merged
Merged
Conversation
…active first Lead with `uncheck init` and the `hooks install` picker, organize sections by what the reader wants to do, and move rare edge cases into collapsed blocks. Fix claims that did not match the source (repeatable flags, the agent loop guard) and add the caveats users trip on.
|
your Pullfrog Router balance is empty, and this repo has no provider key to fall back on, so the agent never ran. To fix, any one of: add a payment method or top up your Router balance · add a provider API key (GitHub Actions secret or Pullfrog secret) · switch this repo to a free model. Top up Router → · Model settings → · Setup docs → · Ask in Discord → |
commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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 README now starts with
npx uncheck initand shows its real questions and final screen. Each section opens with the interactive command and lists the manual setup second. Sections are named after what the reader wants to do, and the visible text is about a third shorter: rare edge cases now sit in collapsed blocks instead of long paragraphs.Fixes
--only,--skipand--require"work on every command".initdoesn't accept them, and--cwdcan't be repeated.initkeeps any existingcheckorfixscripts"fix": truein the sherif config fails every run that only reports.github/hooksfolder existsUnchanged
## Sponsorsthrough## Licenseare byte-identical, sosponsors:synckeeps working.Testing
init, check,stagedandhooks installoutput shown in the README was captured by running the current source.src/and the tests.