Repository navigation
docs: add Simplified Chinese translation (README.zh.md) - #8093
JasonYeYuhe wants to merge 1 commit into
Conversation
Signed-off-by: YE <yyyyy.yeyuhe@gmail.com>
lxcxjxhx
left a comment
There was a problem hiding this comment.
I read the opening section against the English README rather than the whole file, so treat this as a spot check, not a full proofread. What I checked reads well:
- Terminology keeps the English in parentheses — 代码优先(Code-First)、AI 智能体(Agents)— which is the right call for a framework README where the English terms appear in code and docs.
- Links and badges are carried over unchanged, and the "other language versions" list points at the same targets.
- The sentence structure follows Chinese rather than English word order ("助力灵活、可控地构建、评测与部署复杂 AI 智能体"), which is what makes it read as a translation rather than a transliteration.
Two things the file does not say, both about authority rather than language:
-
Which version is authoritative. A reader who lands on
README.zh.mdhas no way to know whether it tracksREADME.mdor has drifted. One line at the top — "本文档为 README.md 的中文翻译,如有出入以英文版为准" — costs nothing and prevents a Chinese-speaking user from filing a bug against a translated sentence that the English version never had. -
How it stays in sync. Nothing in the PR or the repo keeps the two files together. The next English README change will make this one stale silently. That is a maintainer decision (a CI check that both files changed in the same PR is heavy for a README; a
Last synced: <commit>line is cheap), but it is worth deciding now rather than after the first drift.
One structural note: README.zh.md sits next to README.md at the repo root, and the language link was added to the English file — so a Chinese reader arriving at the English README can find it. That is the right direction; the reverse link (a note at the top of the Chinese file pointing back) is the missing half.
Link to Issue or Description of Change
Problem:
Currently, the root
README.mdfor Agent Development Kit (ADK) 2.0 is only available in English, creating an onboarding barrier for Chinese-speaking AI agent developers.Solution:
README.zh.md) covering ADK 2.0 key features (Workflow Runtime, Task API, Modular Multi-Agent Systems, Tool Ecosystem, Code-First Development, Agent Config, Tool Confirmation HITL, Cloud Run / Gemini Enterprise Agent Platform deployment), installation with Python 3.11–3.15 constraints, Quick Start (Agent&Workflowexamples, CLI & Web Dev UI, evaluation), documentation links, community repo, Vibe Coding (llms.txt), and a community translation disclaimer footer.README.mdusing an absolute GitHub URL so links resolve cleanly on thegoogle-adkPyPI package page.Testing Plan
python3 scripts/check_docs.pypasses with 0 errors.mdformat --check README.md(mdformat-gfm) passes with 0 formatting issues.codespell README.md README.zh.mdandgit diff --checkpass with 0 warnings or trailing whitespace.Checklist