Skip to content

docs(uncheck): rewrite the README to be shorter, friendlier and interactive first - #23

Merged
dinwwwh merged 1 commit into
mainfrom
claude/readme-rewrite-a065d1
Oct 2, 2026
Merged

dinwwwh merged 1 commit into
mainfrom
claude/readme-rewrite-a065d1

Conversation

@dinwwwh

@dinwwwh dinwwwh commented Oct 2, 2026

Copy link
Copy Markdown
Member

The README now starts with npx uncheck init and 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

  • The README no longer says --only, --skip and --require "work on every command". init doesn't accept them, and --cwd can't be repeated.
  • The agent loop guard is described correctly: the hook never sends the agent back twice in a row, and a new user turn allows it again.
  • New caveats users trip on:
    • the agent hook never downloads uncheck, so it must be installed in the project
    • init keeps any existing check or fix scripts
    • "fix": true in the sherif config fails every run that only reports
    • Copilot is preselected only when a .github/hooks folder exists

Unchanged

  • The badges block and everything from ## Sponsors through ## License are byte-identical, so sponsors:sync keeps working.

Testing

  • The init, check, staged and hooks install output shown in the README was captured by running the current source.
  • Every claim was fact-checked against src/ and the tests.
  • oxfmt passes, and every in-page anchor link matches a heading.

…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.
@pullfrog

pullfrog Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

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 →

Pullfrog  | Rerun failed job ➔ | View workflow run | via Pullfrog | 𝕏

@pkg-pr-new

pkg-pr-new Bot commented Oct 2, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/uncheck@23

commit: 2b8f2cd

@dinwwwh
dinwwwh merged commit c5a9c6e into main Oct 2, 2026
6 of 7 checks passed
@codecov

codecov Bot commented Oct 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant