Skip to content

readme: lead with the bot, and with having nothing to configure - #43

Merged
Na5co merged 1 commit into
mainfrom
claude/readme-bot
Sep 23, 2026
Merged

Na5co merged 1 commit into
mainfrom
claude/readme-bot

Conversation

@Na5co

@Na5co Na5co commented Sep 23, 2026 •

Copy link
Copy Markdown
Owner

The README opened with "a linter for your app's translations" and an install command. Two things were buried that shouldn't be: what the bot puts on a pull request, and that none of it needs configuring.

  • The opening image is now the review itself — the comment, the suggested change, the Apply suggestion button — in light and dark twins (docs/img/review-comment-{light,dark}.svg), generated from a real finding.
  • Three ways to run it, none of which need configuring: install polygo-bot and stop; or four lines of workflow if you would rather not install an app; or the binary, pointed at any repository including ones you do not own. The install commands live inside that third one instead of being their own section above the value.
  • The check section now says plainly that it finds the files, the locales and the source language itself, and that polygo.toml is for tuning rather than for starting.
  • The CI section no longer repeats the reviewer paragraph now that it is at the top; it points at the app instead.

The DuckDuckGo terminal shot stays, one screen lower, where it reads as evidence for the CLI rather than as the headline.

🤖 Generated with Claude Code

The first thing on the page was a linter and an install command. What people
actually want to know is what lands on their pull request and what it costs
them to find out — which is nothing: install the app, or four lines of CI, or
one binary, and no configuration in any of the three.

So: the review comment as the opening image, then the three ways to run it,
then the checks. The `check` section says plainly that a polygo.toml is for
tuning, not for starting, and the CI section stops repeating the reviewer
paragraph now that it is at the top.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@Na5co
Na5co merged commit 707592a into main Sep 23, 2026
2 checks passed
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