Skip to content

docs: add Chinese translation (README.zh.md)#915

Open
JasonYeYuhe wants to merge 2 commits intoopenclaw:mainfrom
JasonYeYuhe:docs/chinese-readme
Open

docs: add Chinese translation (README.zh.md)#915
JasonYeYuhe wants to merge 2 commits intoopenclaw:mainfrom
JasonYeYuhe:docs/chinese-readme

Conversation

@JasonYeYuhe
Copy link
Copy Markdown

PR Description: docs: add Chinese translation (README.zh.md)

Overview

As the OpenClaw ecosystem expands globally, having localized documentation for its core infrastructure is crucial. This PR introduces a high-quality Chinese translation for ClawHub to help Chinese developers better understand how to publish, version, and manage skills.

Changes

  • README.zh.md: Added a complete Chinese translation covering the vision, CLI commands, repo layout, and local development setup (Convex/Bun).
  • Language Switcher: Added an English · 中文 toggle in the main README.md. It is strategically placed immediately below the badges block to ensure maximum discoverability without interrupting the main prose, adhering to best practices for i18n toggles.

Translation Details

  • Technical terms such as "slug", "frontmatter", "registry", and "telemetry" have been translated into their standard and most intuitive Chinese equivalents (标识符, 前言元数据, 注册中心, 遥测) to maintain developer familiarity.
  • Maintained exact markdown parity, preserving all code blocks and HTML anchors.

Contribution by JasonYeYuhe.

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Mar 16, 2026

@JasonYeYuhe is attempting to deploy a commit to the Amantus Machina Team on Vercel.

A member of the Team first needs to authorize it.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Mar 16, 2026

Greptile Summary

Adds a Chinese translation (README.zh.md) of the project README and a language switcher (English · 中文) in the main README.md. The translation covers the project overview, CLI commands, architecture, local development setup, and environment variables.

  • The language switcher is cleanly implemented with bidirectional links between both files.
  • The Chinese translation is incomplete: several sections from the English README are missing — notably the second half of "Nix plugins" (config requirements, CLI help, alias note), the "Skill metadata" section, and the "Scripts" section. These should be added to maintain full parity.

Confidence Score: 3/5

  • Documentation-only PR with no runtime risk, but the translation is incomplete.
  • Score of 3 reflects that while this is a safe docs-only change with no code impact, the Chinese translation is missing several sections from the English README. Merging as-is would publish an incomplete translation that could mislead Chinese-speaking developers into thinking the documented sections don't exist.
  • README.zh.md — missing translations for Skill metadata, Scripts, and the second half of the Nix plugins section.
Prompt To Fix All With AI
This is a comment left during a code review.
Path: README.zh.md
Line: 146-152

Comment:
**Incomplete translation — missing sections**

The Chinese translation ends after the first Nix plugins example, but the English `README.md` has additional content that is not translated:

- **Config requirements + example snippet** (English lines 157-165): the `metadata.clawdbot.config` YAML example for declaring `requiredEnv`, `stateDirs`, etc.
- **CLI help example** (English lines 167-175): the `metadata.clawdbot.cliHelp` YAML example.
- **`metadata.clawdbot` aliases note** (English line 177): mentions that `metadata.clawdis` and `metadata.openclaw` are accepted aliases.
- **"Skill metadata" section** (English lines 179-200): the `metadata.openclaw.requires` frontmatter reference and example.
- **"Scripts" section** (English lines 202-210): the `bun run dev/build/test/coverage/lint` commands.

These should be translated to maintain full parity with the English README.

How can I resolve this? If you propose a fix, please make it concise.

Last reviewed commit: 1985a3f

Comment thread README.zh.md
Comment on lines +146 to +152
通过 nix-clawdbot 进行安装:

```nix
programs.clawdbot.plugins = [
{ source = "github:clawdbot/nix-steipete-tools?dir=tools/peekaboo"; }
];
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Incomplete translation — missing sections

The Chinese translation ends after the first Nix plugins example, but the English README.md has additional content that is not translated:

  • Config requirements + example snippet (English lines 157-165): the metadata.clawdbot.config YAML example for declaring requiredEnv, stateDirs, etc.
  • CLI help example (English lines 167-175): the metadata.clawdbot.cliHelp YAML example.
  • metadata.clawdbot aliases note (English line 177): mentions that metadata.clawdis and metadata.openclaw are accepted aliases.
  • "Skill metadata" section (English lines 179-200): the metadata.openclaw.requires frontmatter reference and example.
  • "Scripts" section (English lines 202-210): the bun run dev/build/test/coverage/lint commands.

These should be translated to maintain full parity with the English README.

Prompt To Fix With AI
This is a comment left during a code review.
Path: README.zh.md
Line: 146-152

Comment:
**Incomplete translation — missing sections**

The Chinese translation ends after the first Nix plugins example, but the English `README.md` has additional content that is not translated:

- **Config requirements + example snippet** (English lines 157-165): the `metadata.clawdbot.config` YAML example for declaring `requiredEnv`, `stateDirs`, etc.
- **CLI help example** (English lines 167-175): the `metadata.clawdbot.cliHelp` YAML example.
- **`metadata.clawdbot` aliases note** (English line 177): mentions that `metadata.clawdis` and `metadata.openclaw` are accepted aliases.
- **"Skill metadata" section** (English lines 179-200): the `metadata.openclaw.requires` frontmatter reference and example.
- **"Scripts" section** (English lines 202-210): the `bun run dev/build/test/coverage/lint` commands.

These should be translated to maintain full parity with the English README.

How can I resolve this? If you propose a fix, please make it concise.

@JasonYeYuhe
Copy link
Copy Markdown
Author

Thank you for catching that! I have appended the missing sections (config, cliHelp, Skill metadata, and Scripts) to
ensure complete parity with the English README.

@clawsweeper
Copy link
Copy Markdown

clawsweeper Bot commented Apr 28, 2026

Codex review: found issues before merge.

What this changes:

The PR adds a root README.zh.md Chinese translation and inserts a centered English/中文 switcher into the root README.md.

Maintainer follow-up before merge:

The remaining action needs maintainer localization policy judgment and fluent Simplified Chinese review, not a safe autonomous repair lane for an already-open docs PR.

Security review:

Security review cleared: The PR is documentation-only and does not change workflows, dependencies, lockfiles, install scripts, secrets, permissions, publishing metadata, downloaded artifacts, or code execution paths.

Review findings:

  • [P2] Refresh the translation against current README — README.zh.md:16
Review details

Best possible solution:

Refresh README.zh.md from the current root README, include the current OpenClaw package catalog and plugin publishing sections, keep the bidirectional language switcher only if maintainers want localized root README docs, and complete a fluent Simplified Chinese terminology/parity review before merge.

Full review comments:

  • [P2] Refresh the translation against current README — README.zh.md:16
    README.zh.md still translates the older Clawdbot-era opening and CLI scope. Current main now describes ClawHub as the OpenClaw skill registry and includes native package catalog/plugin publishing flows, so merging this translation would publish stale project-scope documentation.
    Confidence: 0.94

Overall correctness: patch is incorrect
Overall confidence: 0.91

Acceptance criteria:

  • Manual markdown parity review between current README.md and refreshed README.zh.md
  • Manual fluent Simplified Chinese terminology review
  • bun run format:check

What I checked:

  • Current main has no translated root README: The tracked README files on current main are README.md, docs/README.md, packages/clawhub/README.md, and packages/schema/README.md; no README.zh.md exists on main. (7bef2a0b65d4)
  • Current README now describes OpenClaw package scope: Current main describes ClawHub as the public skill registry for OpenClaw, adds native OpenClaw package catalog scope, and documents package explore/inspect and package publish CLI flows. (README.md:13, 7bef2a0b65d4)
  • PR translation is based on older Clawdbot wording: The PR diff adds README.zh.md with the opening sentence translated as ClawHub being Clawdbot's public skill registry, and the PR's README diff is against an older English README opening that still says Clawdbot. (README.zh.md:16, 4587a3cd879f)
  • PR branch is open and dirty: The GitHub API reports this PR open, unmerged, mergeable: false, mergeable_state: dirty, with two commits and two changed Markdown files. (4587a3cd879f)
  • Earlier parity review was partly addressed: A prior review comment flagged missing translated sections in the initial commit; the PR author then added a second commit for config, cliHelp, skill metadata, and scripts, so the current blocker is drift from newer main rather than that original omission alone. (README.zh.md:146, 4587a3cd879f)
  • Broader app i18n remains separately tracked: Related issue feat: add i18n support with zh-CN (Simplified Chinese) locale #606 is still open for zh-CN application i18n; this PR is README-only and should not be treated as completing that broader localization effort.

Likely related people:

  • steipete: Authored the release-prep commit that introduced the current root README, docs index, and package README snapshot that a translated root README should now match. (role: current README/docs feature-history owner; confidence: high; commits: 8752e4bb7e92; files: README.md, docs/README.md, packages/clawhub/README.md)
  • Patrick Erichsen: Current README blame points through the merge commit for the CLI 0.12.1 release-prep snapshot that brought the current README/docs content onto main. (role: recent main integrator; confidence: medium; commits: ecf09b868a98; files: README.md, docs/README.md, packages/clawhub/README.md)
  • BunsDev: Authored the README wording change from Clawdbot to OpenClaw, which is the central terminology drift in this PR. (role: adjacent docs/product wording maintainer; confidence: medium; commits: f4ddccbead42; files: README.md)

Remaining risk / open question:

  • Merging as-is would publish localized root documentation that still reflects older Clawdbot-era scope instead of the current OpenClaw package catalog and plugin publishing behavior.
  • Translation quality, technical terminology, and markdown parity still need fluent Simplified Chinese review.
  • Maintainers still need to decide whether root README localization is desired separately from the broader app i18n work tracked in feat: add i18n support with zh-CN (Simplified Chinese) locale #606.

Codex review notes: model gpt-5.5, reasoning high; reviewed against 7bef2a0b65d4.

@clawsweeper
Copy link
Copy Markdown

clawsweeper Bot commented Apr 29, 2026

Codex review: needs maintainer review before merge.

What this changes:

Review failed before ClawSweeper could summarize the requested change.

Maintainer follow-up before merge:

Review did not complete, so no work-lane recommendation was made.

Review details

Best possible solution:

Retry the Codex review after fixing the execution failure.

What I checked:

  • failure reason: timeout.
  • codex failure detail: Codex review failed for this PR: spawnSync codex ETIMEDOUT.
  • codex stdout: Per-item Codex failure; continuing with the rest of the shard.

Likely related people:

  • unknown: Codex failed before it could trace repository history. (role: review did not complete; confidence: low)

Remaining risk / open question:

  • No close action taken because the review did not complete.

Codex review notes: model gpt-5.5, reasoning high; reviewed against 7bef2a0b65d4.

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