Skip to content

docs: Add README.zh-CN.md file#107

Merged
affaan-m merged 1 commit into
affaan-m:mainfrom
XinChou16:docs/zh_cn
Jan 29, 2026
Merged

docs: Add README.zh-CN.md file#107
affaan-m merged 1 commit into
affaan-m:mainfrom
XinChou16:docs/zh_cn

Conversation

@XinChou16

@XinChou16 XinChou16 commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

i18n update.

Summary by CodeRabbit

  • Documentation
    • Added language switching feature to the README, allowing users to easily select between English and Chinese versions of the complete project documentation
    • Introduced comprehensive Chinese localization that covers all sections including guides, installation instructions, core concepts, ecosystem tools, testing procedures, contribution guidelines, and platform-specific setup instructions for Windows, macOS, and Linux

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai

coderabbitai Bot commented Jan 28, 2026

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

The pull request adds bilingual documentation support. It introduces a language-switch UI in README.md and creates a complete Chinese translation (README.zh-CN.md) mirroring the English documentation structure, covering installation, concepts, tools, testing, and contribution guidelines.

Changes

Cohort / File(s) Summary
Documentation and Localization
README.md, README.zh-CN.md
Added language-switch UI block (English) linking to Chinese README; created comprehensive Chinese localization with translated sections for guides, installation, core concepts, ecosystem tools, tests, contributions, and background information

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A rabbit hopped through README's pages,
With English words that span the ages,
Then added Chinese, side by side—
Two languages, both spoken with pride! 🐰🌍

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: Add README.zh-CN.md file' is clear, specific, and directly describes the main change - adding a Chinese localization README file to the repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

@affaan-m affaan-m merged commit fbe2e56 into affaan-m:main Jan 29, 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.

3 participants