Skip to content

docs: add Simplified Chinese README#189

Open
whtis wants to merge 1 commit into
millionco:mainfrom
whtis:night-shift/20260510-readme-zh-cn
Open

docs: add Simplified Chinese README#189
whtis wants to merge 1 commit into
millionco:mainfrom
whtis:night-shift/20260510-readme-zh-cn

Conversation

@whtis
Copy link
Copy Markdown

@whtis whtis commented May 9, 2026

What

Adds a Simplified Chinese translation of the README at README.zh-CN.md.

Why

React Doctor is being picked up by the Chinese React community (it's been making the rounds in WeChat dev groups), and a localized README lowers the bar for first-time users who want to evaluate the tool before sharing it with their team. Keeping the English README.md as the source of truth — the new file is a sibling, not a replacement.

Notes

  • 1:1 with the structure of the current English README, including all code blocks, the leaderboard table, the config-keys table, and inline links.
  • Technical names kept in English where that reads more naturally to a Chinese developer (oxlint, ESLint, Next.js, pnpm, rule ids, CLI flags, etc.).
  • I left README.md untouched since it's symlinked into packages/react-doctor/ and gets published to npm — happy to add a language switcher line at the top if you'd prefer one there too.
  • If you'd rather have the file live under a different path (e.g. docs/i18n/), let me know and I'll move it.

Drafted with AI assistance; verified by author before publishing.


Note

Low Risk
Low risk documentation-only change that adds a new markdown file without affecting runtime behavior or builds.

Overview
Adds README.zh-CN.md, a Simplified Chinese, structure-matching translation of the existing README (install/agent setup, GitHub Actions usage, configuration and CLI reference, API notes, and leaderboard), with a language toggle linking back to README.md.

Reviewed by Cursor Bugbot for commit e4d76fc. Bugbot is set up for automated code reviews on this repo. Configure here.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 9, 2026

@whtis is attempting to deploy a commit to the Million Team on Vercel.

A member of the Team first needs to authorize it.

@reactreview
Copy link
Copy Markdown

reactreview Bot commented May 9, 2026

Merging this PR does not change React health

➡️ 0 score
❌ 0 errors
⚠️ 0 warnings

BASE HEAD Change
Score 0 0 0
Errors 26 26 0
Warnings 261 261 0
Analysis details

analyzed in 0.7s · nextjs · React 19.2.5 · TypeScript · 210 source files · powered by react-doctor

@whtis whtis marked this pull request as ready for review May 10, 2026 10:17
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