Skip to content

docs: restructure README and remove duplication - #92

Merged
him0 merged 1 commit into
mainfrom
docs/readme-brushup
Nov 19, 2026
Merged

him0 merged 1 commit into
mainfrom
docs/readme-brushup

Conversation

@him0

@him0 him0 commented Nov 19, 2026

Copy link
Copy Markdown
Owner

Summary

Restructures README.md and README.ja.md (same layout in both). About 10% shorter; the main change is removing duplication. No behavior change.

  • Shorten the action table to the outcome only, without the full warning text in each row
  • Gather the merged-branch rules into a new "Merged branches" section
  • Trim Safety to five points; the pull request lookup failure details move to Troubleshooting
  • Move "Other worktrees" after Options and put the reasons --remove-worktrees is off by default before the refusal examples
  • Turn "Color and output" into a list (stdout / stderr / exit status / color)
  • Fold Requirements into Installation and Acknowledgments into the intro

Removed

  • The warning text for ahead / diverged / unmerged branches that was in the table
  • "one request per 50 branches"
  • The mention of the Switched to branch ... message
  • The config key in the --remove-worktrees table row (still in "Removing worktrees")

The #other-worktrees, #removing-worktrees and #excluding-branches anchors still work; #requirements and #acknowledgments are gone.

🤖 Generated with Claude Code

Gather the merged-branch rules into their own section, shorten the
action table, move worktrees after the options, and fold Requirements
and Acknowledgments into the installation and intro.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 19, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 40 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 18796508-6ab2-4f45-8433-336214f8a11a
Commits

Reviewing files that changed from the base of the PR and between b5b52d1 and c5a4497.

Files selected for processing: 2

  • README.ja.md
  • README.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@him0
him0 merged commit 0df078b into main Nov 19, 2026
6 of 7 checks passed
@him0
him0 deleted the docs/readme-brushup branch November 19, 2026 16:33
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