Skip to content

feat: add Simplified Chinese README translation#1890

Merged
senamakel merged 3 commits into
tinyhumansai:mainfrom
LuoYe17:claude/thirsty-mendeleev-64301a
May 16, 2026
Merged

feat: add Simplified Chinese README translation#1890
senamakel merged 3 commits into
tinyhumansai:mainfrom
LuoYe17:claude/thirsty-mendeleev-64301a

Conversation

@LuoYe17
Copy link
Copy Markdown
Contributor

@LuoYe17 LuoYe17 commented May 16, 2026

Summary

  • Added README.zh-CN.md with a full Simplified Chinese translation of the English README
  • Added a prominent language switcher (🌐 English | 简体中文) at the top of both @README.md and @README.zh-CN.md
  • Added language badge links in the badges row of both files

Summary by CodeRabbit

  • Documentation
    • Added a full Simplified Chinese README with project overview, install/getting-started, contribution guidance, feature comparisons, and contributor highlights.
    • Added a top-right language selector to toggle between English and Simplified Chinese documentation.
    • Added a Simplified Chinese language badge in the header for improved discoverability.

Review Change Stack

@LuoYe17 LuoYe17 requested a review from a team May 16, 2026 03:38
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 16, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b1db9926-5ee1-4f18-8678-6ae825049f43

📥 Commits

Reviewing files that changed from the base of the PR and between 505b7f8 and c718d7a.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This PR adds Simplified Chinese localization: README.md gets a language selector and a 简体中文 badge; a new README.zh-CN.md provides full Chinese documentation (installation, features, contribution guide, comparisons, and community sections).

Changes

Chinese README Localization

Layer / File(s) Summary
English README language switcher
README.md
Adds a centered flag-based language selector linking README.md and README.zh-CN.md, and a 简体中文 header badge linking to README.zh-CN.md.
Simplified Chinese README
README.zh-CN.md
New comprehensive Chinese README with branding/language switch, early-access and install commands (macOS/Linux, Windows), feature overview, contribution workflow, context-building/Memory backend notes, OpenHuman vs other frameworks comparison, GitHub stars callout with history chart, and contributors hall of fame section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

Poem

🐇 I hopped through markdown rows,
Placed flags where language flows,
English greets Chinese light,
Docs now bilingual and bright,
A tiny rabbit's README prose.

🚥 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 accurately describes the main change: adding a Simplified Chinese README translation, which is the primary focus of the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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.zh-CN.md`:
- Line 87: The inline <img> tag in README.zh-CN.md is missing an alt attribute
which hurts accessibility and triggers markdown lint warnings; update the <img
src="./gitbooks/.gitbook/assets/image (1).png" /> element to include a concise,
descriptive alt text (for example alt="描述性文字" or an equivalent Chinese
description appropriate to the image) so screen readers and linters have
meaningful content.
- Around line 46-54: The fenced install code block in README.zh-CN.md is
unlabeled which breaks markdown linting; update the opening fence to include a
language identifier (e.g., change "```" to "```bash") for the install commands
shown (the block that begins with the Chinese install comment and the curl/irm
lines) so syntax highlighting and linters recognize it.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 169d5809-965a-49e1-a750-9dde101eb724

📥 Commits

Reviewing files that changed from the base of the PR and between efab59b and 3a6a50a.

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

Comment thread README.zh-CN.md Outdated
Comment thread README.zh-CN.md Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes May 16, 2026
@LuoYe17
Copy link
Copy Markdown
Contributor Author

LuoYe17 commented May 16, 2026

@senamakel Please check

Updated language links and added status badge.
@senamakel senamakel merged commit 9dbb77c into tinyhumansai:main May 16, 2026
11 of 13 checks passed
@senamakel
Copy link
Copy Markdown
Member

really well done. thank you so much for the PR

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.

2 participants