docs: add Chinese translation for README#507
docs: add Chinese translation for README#507JasonYeYuhe wants to merge 1 commit intobradygaster:devfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a Chinese translation of the repository README and exposes a language switcher in the main README to improve accessibility for Chinese-speaking users.
Changes:
- Added
README.zh.md(Chinese README translation). - Added an English/Chinese language selector near the top of
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.zh.md | Introduces Chinese-localized README content (quick start, command reference, architecture overview). |
| README.md | Adds a language switcher linking to the Chinese translation. |
|
|
||
| > ⚠️ **Alpha 预览版** — Squad 仍处于实验阶段。API 和命令行工具可能在版本更迭中发生变化。我们会在 [CHANGELOG.md](CHANGELOG.md) 中记录重大变更。 | ||
|
|
||
| --- | ||
|
|
There was a problem hiding this comment.
The badge links point to #status and #what-is-squad, but this Chinese README doesn’t define those anchors (there is no “Status” section, and the “什么是 Squad?” heading won’t slug to what-is-squad). This results in broken in-page navigation. Consider adding explicit HTML anchors (<a name="status"></a>, <a name="what-is-squad"></a>) or updating the badge targets to match the actual heading slugs/sections in this file.
| > ⚠️ **Alpha 预览版** — Squad 仍处于实验阶段。API 和命令行工具可能在版本更迭中发生变化。我们会在 [CHANGELOG.md](CHANGELOG.md) 中记录重大变更。 | |
| --- | |
| <a name="status"></a> | |
| > ⚠️ **Alpha 预览版** — Squad 仍处于实验阶段。API 和命令行工具可能在版本更迭中发生变化。我们会在 [CHANGELOG.md](CHANGELOG.md) 中记录重大变更。 | |
| --- | |
| <a name="what-is-squad"></a> |
|
|
||
| **✓ 验证：** 运行 `gh auth status` — 你应该看到 "Logged in to github.com"。 | ||
|
|
||
| ### 4. 开启 Copilot 开启工作 |
There was a problem hiding this comment.
Section title has duplicated wording (“开启 … 开启 …”), which reads like a copy/paste error. Suggest rephrasing to a single verb phrase to improve readability.
| ### 4. 开启 Copilot 开启工作 | |
| ### 4. 开启 Copilot 工作 |
| | `squad init` | **初始化** — 在当前目录初始化 Squad（幂等操作 — 可安全运行多次）；别名：`hire`；使用 `--global` 在个人目录初始化，`--mode remote <path>` 开启双根模式 | | ||
| | `squad upgrade` | 将 Squad 相关文件更新至最新版；绝不会触动你的团队状态；别名：`upgrade`；使用 `--migrate-directory` 可将 `.ai-team/` 重命名为 `.squad/` | | ||
| | `squad status` | 显示当前活跃的小队及其状态 | | ||
| | `squad triage` | 监控 Issue 并自动分发给团队成员（别名：`watch`, `loop`）；使用 `--interval <minutes>` 设置轮询频率（默认 10 分钟） | |
There was a problem hiding this comment.
The command table lists some aliases that don’t match the current CLI behavior: hire and loop are implemented as separate commands (not aliases), and triage is the one that aliases watch (see packages/squad-cli/src/cli-entry.ts). Also, listing upgrade as an alias for squad upgrade is redundant/misleading. Please update the table to reflect the actual commands/aliases.
| | `squad init` | **初始化** — 在当前目录初始化 Squad（幂等操作 — 可安全运行多次）；别名：`hire`；使用 `--global` 在个人目录初始化，`--mode remote <path>` 开启双根模式 | | |
| | `squad upgrade` | 将 Squad 相关文件更新至最新版；绝不会触动你的团队状态；别名：`upgrade`；使用 `--migrate-directory` 可将 `.ai-team/` 重命名为 `.squad/` | | |
| | `squad status` | 显示当前活跃的小队及其状态 | | |
| | `squad triage` | 监控 Issue 并自动分发给团队成员（别名：`watch`, `loop`）；使用 `--interval <minutes>` 设置轮询频率（默认 10 分钟） | | |
| | `squad init` | **初始化** — 在当前目录初始化 Squad（幂等操作 — 可安全运行多次）；使用 `--global` 在个人目录初始化，`--mode remote <path>` 开启双根模式 | | |
| | `squad upgrade` | 将 Squad 相关文件更新至最新版；绝不会触动你的团队状态；使用 `--migrate-directory` 可将 `.ai-team/` 重命名为 `.squad/` | | |
| | `squad status` | 显示当前活跃的小队及其状态 | | |
| | `squad watch` | 监控 Issue 并自动分发给团队成员（别名：`triage`）；使用 `--interval <minutes>` 设置轮询频率（默认 10 分钟） | | |
| | `squad loop` | 循环运行 Issue 监控流程并自动分发给团队成员；使用 `--interval <minutes>` 设置轮询频率（默认 10 分钟） | |
| | `squad upstream add\|remove\|list\|sync` | 管理上游 Squad 源码 | | ||
| | `squad nap` | 上下文清理 — 压缩、剪枝、归档；使用 `--deep` 进行深度压缩，`--dry-run` 预览更改 | | ||
| | `squad aspire` | 打开 Aspire 仪表盘以进行可观测性监控 | | ||
| | `squad scrub-emails [directory]` | 从状态文件中移除电子邮件地址（默认目录：`.squad/`） | |
There was a problem hiding this comment.
squad scrub-emails default directory is documented here as .squad/, but the CLI currently defaults to .ai-team/ when no directory argument is provided (see packages/squad-cli/src/cli-entry.ts). This could cause users to think the command did nothing when it actually scanned a different directory.
| | `squad scrub-emails [directory]` | 从状态文件中移除电子邮件地址（默认目录：`.squad/`） | | |
| | `squad scrub-emails [directory]` | 从状态文件中移除电子邮件地址（默认目录：`.ai-team/`） | |
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>
|
Hi @JasonYeYuhe! 👋 Thank you so much for taking the time to create this Chinese translation! Your work provided an excellent foundation with great terminology choices like 智能体, 协调员, 花名册, 选角, and 书记员. Since you opened this PR, we've added several new sections to the README (Upgrading, Samples, SDK-First Mode, Monorepo Development, and more). I've incorporated your translation work into an updated PR (#572) that includes all these new sections while preserving your terminology and style. I've added you as a co-author in the commit, and your contribution is credited in the new PR. Your translation work is very much appreciated! 🙏 The new PR: #572 |
…radygaster#540) Wires 5 ghost commands: hire→init, heartbeat→doctor, shell→REPL, loop→triage, run→stub with redirect. Closes bradygaster#501, Closes bradygaster#503, Closes bradygaster#504, Closes bradygaster#507, Closes bradygaster#509 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds complete Chinese translation of README.md based on the excellent work by @JasonYeYuhe in PR bradygaster#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 bradygaster#507 Co-authored-by: JasonYeYuhe <69640321+JasonYeYuhe@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
docs: add high-quality Chinese translation for README
Description
This PR introduces a high-quality Chinese translation of the README (
README.zh.md) and adds a language switcher to the mainREADME.md.Motivation
Squad is an innovative tool representing the "Repository-Native Agents" trend, recently featured on the GitHub Blog. As adoption of GitHub Copilot and agentic workflows surges within the Chinese developer community, providing localized documentation is crucial for making this project accessible to a wider audience.
This translation ensures that:
Changes
README.zh.mdwith localized technical terminology.Translated and contributed by @JasonYeYuhe