Skip to content

docs: add Chinese (zh-CN) translations for README, AGENTS, and CLA#1719

Open
jetsonearth wants to merge 3 commits intodimensionalOS:mainfrom
jetsonearth:docs/zh-CN-main
Open

docs: add Chinese (zh-CN) translations for README, AGENTS, and CLA#1719
jetsonearth wants to merge 3 commits intodimensionalOS:mainfrom
jetsonearth:docs/zh-CN-main

Conversation

@jetsonearth
Copy link
Copy Markdown

Summary

  • Add README.zh-CN.md, AGENTS.zh-CN.md, CLA.zh-CN.md with full Simplified Chinese translations
  • Add language switcher (English | 中文) to the top of existing English README.md, AGENTS.md, and CLA.md
  • Follows the *.zh-CN.md convention used by major open-source projects (Vue, Electron, etc.), making it easy for the community to contribute additional languages (ja, ko, es, de, etc.)

Test plan

  • Verify Chinese README renders correctly on GitHub
  • Verify language switcher links work in both directions (English ↔ 中文)
  • Spot-check translation accuracy for technical terminology

🤖 Generated with Claude Code

jetsonearth and others added 2 commits March 31, 2026 14:48
- Add README.zh-CN.md, AGENTS.zh-CN.md, CLA.zh-CN.md
- Add language switcher (English | 中文) to existing English docs

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 31, 2026

Greptile Summary

This PR adds Simplified Chinese (zh-CN) translations for README.md, AGENTS.md, and CLA.md, along with bidirectional language switchers (English | 中文) at the top of each file. The translations are thorough and technically accurate, faithfully preserving code blocks, badges, HTML tables, and asset references.

Key observations:

  • All six bidirectional links (English ↔ 中文) are correctly cross-referenced.
  • Code blocks, CLI commands, Python snippets, and file paths are correctly preserved (untranslated) throughout all three new files.
  • The README.zh-CN.md language switcher is placed inside the existing <big><big> block, mirroring the English README's placement for visual consistency.
  • One code example in AGENTS.zh-CN.md was modified from the English source: agent(system_prompt=G1_SYSTEM_PROMPT) was changed to McpClient.blueprint(system_prompt=G1_SYSTEM_PROMPT) — the English doc and actual codebase usage both use agent(...), so this translation should be corrected to match.

Confidence Score: 4/5

Safe to merge after fixing one code example that diverges from the English source and actual codebase usage.

Five of six changed files are clean. The single P1 finding is a code snippet in AGENTS.zh-CN.md that substitutes McpClient.blueprint(system_prompt=G1_SYSTEM_PROMPT) for the documented and implemented agent(system_prompt=G1_SYSTEM_PROMPT), which would give Chinese-speaking contributors incorrect guidance.

AGENTS.zh-CN.md line 280 — incorrect code example compared to English source.

Important Files Changed

Filename Overview
AGENTS.zh-CN.md Full Chinese translation of AGENTS.md; mostly accurate, but one code example was incorrectly changed from agent(system_prompt=...) to McpClient.blueprint(system_prompt=...), diverging from the English source and actual codebase usage.
AGENTS.md Added a two-way language switcher (`English
CLA.md Added language switcher at the very top; link target is correct.
CLA.zh-CN.md Full Chinese translation of CLA.md; legal content faithfully translated; bidirectional link back to CLA.md is correct.
README.md Added language switcher inside the existing <big><big> block; consistent with README.zh-CN.md placement; link target is correct.
README.zh-CN.md Full 331-line Chinese translation of README.md; preserves all code blocks, badges, HTML tables, and asset links; language switcher placed symmetrically inside <big><big> block.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md] <-->|Language Switcher| B[README.zh-CN.md]
    C[AGENTS.md] <-->|Language Switcher| D[AGENTS.zh-CN.md]
    E[CLA.md] <-->|Language Switcher| F[CLA.zh-CN.md]

    D -->|⚠️ Code example diverges| G["McpClient.blueprint(system_prompt=...)
    should be agent(system_prompt=...)"]
Loading

Reviews (1): Last reviewed commit: "docs: move language switcher below pre-r..." | Re-trigger Greptile

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
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