Skip to content

docs: add Simplified Chinese translation of README (README.zh.md)#21

Open
hanzhe-one wants to merge 3 commits into
FROWNINGdev:mainfrom
hanzhe-one:docs/translate-readme-zh
Open

docs: add Simplified Chinese translation of README (README.zh.md)#21
hanzhe-one wants to merge 3 commits into
FROWNINGdev:mainfrom
hanzhe-one:docs/translate-readme-zh

Conversation

@hanzhe-one

@hanzhe-one hanzhe-one commented Jul 16, 2026

Copy link
Copy Markdown

What

  • Add README.zh.md with a full Simplified Chinese translation of the README.
  • Add a language switcher link to the top of README.md.

Acceptance (from #10)

  • File README.zh.md at repo root
  • Badges + install commands kept verbatim
  • Language switcher added to top of README.md

Closes #10

Summary by CodeRabbit

  • Documentation
    • Updated the README with English and Simplified Chinese language options.
    • Clarified installation paths and the differences between CLI-only and MCP installations.
    • Added a complete Chinese-language README covering features, setup, integrations, configuration, usage, roadmap, FAQ, and support.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@hanzhe-one, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 46 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bfe059ad-4349-4245-9a49-398f862e2489

📥 Commits

Reviewing files that changed from the base of the PR and between 031583e and 9532fbc.

📒 Files selected for processing (2)
  • README.md
  • README.zh.md
📝 Walkthrough

Walkthrough

README.md adds a language switcher and clarifies installation commands. README.zh.md adds a complete Simplified Chinese version covering setup, features, integrations, configuration, roadmap, FAQs, support, contributors, and licensing.

Changes

README documentation

Layer / File(s) Summary
Language navigation and installation
README.md, README.zh.md
The English README adds English/Chinese navigation and install command annotations; the Chinese README adds translated entry and installation guidance.
Feature usage and integrations
README.zh.md, README.md
Chinese documentation covers extension capabilities, CLI and MCP usage, integrations, and quick-start instructions while corresponding English sections remain substantively unchanged.
Reference, roadmap, and support content
README.md, README.zh.md
Chinese reference sections document audiences, comparisons, configuration, commands, roadmap, FAQs, support, contributors, licensing, and footer links; matching English sections are preserved.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related issues

  • #11 — Adds a translated README and language switcher for another language, matching this PR’s documentation pattern.

Suggested reviewers: frowningdev

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly states the main change: adding a Simplified Chinese README translation.
Linked Issues check ✅ Passed The PR matches #10 by adding README.zh.md, linking the language switcher, and preserving the install commands and badges.
Out of Scope Changes check ✅ Passed The README updates stay within the documented translation and navigation goals, with no unrelated code changes evident.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 137-138: The installation commands in README.md lines 137-138 and
README.zh.md lines 135-136 must remain verbatim without inline comments; remove
the CLI and MCP annotations from both command blocks, and move their
explanations into the surrounding prose.
- Line 12: Fix the skipped heading level in README.md at lines 12-12 and
README.zh.md at lines 10-10 by converting each tagline to a paragraph or
changing it to an h2, preserving the existing text and avoiding a ### heading
directly after the top-level title.

In `@README.zh.md`:
- Line 353: Update the Chinese sentence in the README so “工具有” becomes “的工具:”,
preserving the existing list of VS Code extension, CLI, and MCP server
offerings.
- Line 118: Update the bold link in the README text by removing the space
between the opening bold marker and the link, preserving the link text, URL, and
closing bold marker.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1dac8958-40dc-4d20-9f11-aed5a4e19d92

📥 Commits

Reviewing files that changed from the base of the PR and between 4c80741 and 031583e.

📒 Files selected for processing (2)
  • README.md
  • README.zh.md

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.zh.md Outdated
Comment thread README.zh.md Outdated
- Demote tagline from h3 to paragraph in both READMEs (MD001)
- Remove inline comments from install commands to keep them verbatim (MD040)
- Fix bold-link spacing in README.zh.md (MD037)
- Fix Chinese grammar: 工具有 -> 的工具

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@hanzhe-one hanzhe-one closed this Jul 18, 2026
@hanzhe-one hanzhe-one reopened this Jul 18, 2026
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.

Docs: translate README.md → README.zh.md (Chinese)

1 participant