Skip to content

docs: update Chinese README translation#572

Merged
bradygaster merged 1 commit intodevfrom
squad/507-chinese-readme
Mar 23, 2026
Merged

docs: update Chinese README translation#572
bradygaster merged 1 commit intodevfrom
squad/507-chinese-readme

Conversation

@bradygaster
Copy link
Copy Markdown
Owner

Overview

This PR provides a complete, up-to-date Chinese translation of README.md.

Supersedes #507 — This incorporates and extends @JasonYeYuhe's excellent translation work from that PR.

What's New

This translation brings the Chinese README current with all recent additions to the English version:

New Sections Translated

  • Upgrading — Two-step upgrade process (CLI binary + squad upgrade command)
  • What the Shell Does — Real-time visibility, message routing, parallel execution, session persistence, decision logging
  • Samples — Eight working examples from beginner to advanced
  • SDK-First Mode — Experimental TypeScript config alternative to markdown
  • Monorepo Development — Building, testing, linting, and publishing workflow
  • SDK Documentation — Links to API reference, tools/hooks guide, extensibility guide

Updated Content

  • Commands table — Updated \squad upgrade\ command description to include --global\ flag
  • Language switcher — Added to both README.md and README.zh.md

Translation Quality

  • Preserves @JasonYeYuhe's excellent terminology choices:
    • 智能体 (AI agent)
    • 协调员 (Coordinator)
    • 花名册 (Roster)
    • 选角 (Casting)
    • 书记员 (Scribe)
    • 钩子流水线 (Hook Pipeline)
  • Uses idiomatic Chinese developer terminology
  • Keeps technical terms (npm, git, CLI, TypeScript, SDK, API, PR) in English where appropriate
  • Maintains all markdown formatting, code blocks, and links identical to English version

Credit

Translation based on work by @JasonYeYuhe in #507 — thank you for starting this! Your terminology choices and translation style provided an excellent foundation.


Closes #507

Adds complete Chinese translation of README.md based on the excellent
work by @JasonYeYuhe in PR #507. This update brings the Chinese README
current with all recent additions to the English README.

Updates include:
- New 'Upgrading' section (two-step upgrade process)
- 'What the Shell Does' subsection (real-time visibility, routing, etc.)
- 'Samples' section (eight working examples)
- 'SDK-First Mode' section (experimental TypeScript config)
- 'Monorepo Development' section (building, testing, linting, publishing)
- 'SDK documentation' section with reference links
- Updated 'upgrade' command description with --global flag
- Language switcher added to both READMEs

Translation preserves JasonYeYuhe's terminology choices for technical
concepts like '智能体' (agent), '协调员' (Coordinator), '花名册' (Roster),
'选角' (Casting), and '书记员' (Scribe).

Supersedes #507

Co-authored-by: JasonYeYuhe <69640321+JasonYeYuhe@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bradygaster bradygaster merged commit 4cc0e22 into dev Mar 23, 2026
2 checks passed
@bradygaster bradygaster deleted the squad/507-chinese-readme branch March 26, 2026 07:56
@JasonYeYuhe
Copy link
Copy Markdown
Contributor

Thank you very much.

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