docs(zh-cn): add Chinese translation for core-tools reference#2002
Merged
alexeyv merged 2 commits intobmad-code-org:mainfrom Mar 15, 2026
Merged
docs(zh-cn): add Chinese translation for core-tools reference#2002alexeyv merged 2 commits intobmad-code-org:mainfrom
alexeyv merged 2 commits intobmad-code-org:mainfrom
Conversation
翻译 docs/reference/core-tools.md，覆盖全部 11 个核心工具的说明。 保留技能命令名和参数名不译，描述性内容使用自然中文表达。 Made-with: Cursor
📝 WalkthroughWalkthroughA new Chinese-language documentation page for BMad core tools is added, providing comprehensive reference material for 11 core tools with descriptions, use cases, inputs, outputs, and operational details. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related issues
Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip You can make CodeRabbit's review stricter and more nitpicky using the `assertive` profile, if that's what you prefer.Change the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (2)
docs/zh-cn/reference/core-tools.md (2)
10-12: 命令调用示例与项目标准不一致（缺少/前缀）。这里写的是
bmad-help，但项目文档里技能调用语法是/bmad-help。建议统一成斜杠前缀，避免用户在 IDE 中直接照抄失败。Based on learnings: “slash-prefixed skill invocations (e.g.,
/bmad-help) are the standard IDE invocation syntax … Reviewers should not flag slash-prefixed invocations as legacy.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh-cn/reference/core-tools.md` around lines 10 - 12, Update the example invocation in docs/zh-cn/reference/core-tools.md to use the project's standard slash-prefixed skill syntax by replacing the bare token "bmad-help" with "/bmad-help" (keeping the surrounding text and formatting intact) so IDE users can copy-paste the correct invocation; ensure any other occurrences in the same file also follow the "/<skill-name>" pattern.
195-195: JSON 输出只给了字段名，缺少最小示例，契约不够可执行。建议补一个 1 条记录的 JSON 样例，明确
location格式（行号/文件路径）、guard_snippet是否可空，避免下游解析歧义。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh-cn/reference/core-tools.md` at line 195, 在现有描述只列出字段名的地方，补充一个包含单条记录的 JSON 最小示例，明确展示 location 的具体格式（例如 "file:path/to/file:line" 或 "path/to/file:lineNumber"）、trigger_condition 的示例字符串、guard_snippet 可以为 null 或字符串（示例中体现 null 情形以表明可空），以及 potential_consequence 的示例文本；确保示例包含字段 "location"、"trigger_condition"、"guard_snippet" 和 "potential_consequence" 并在说明中明确说明 location 格式规范和 guard_snippet 可为空以避免下游解析歧义。
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/zh-cn/reference/core-tools.md`:
- Line 143: 翻译中把交互菜单选项 `continue` 错误地译为中文“继续”，违反了未翻译标识符规则；请在
docs/zh-cn/reference/core-tools.md 把“继续”改回原 token `continue` 并在同一处添加中文解释（如
`continue（继续执行/继续）`），确保保留原始标识符 `continue` 而只在括号内提供中文说明以便阅读。
- Around line 94-95: 在列出退出指令的那一行为命令 'goodbye'、'end party'、'quit'
补充精确行为说明：说明是否区分大小写（例如“大小写不敏感”或“大小写敏感”）、是否仅支持英文关键字（例如“仅支持英文，不支持本地化词”）以及是否需要精确匹配或支持部分匹配/前缀匹配；在该条后附加一小句如“（大小写不敏感，仅支持英文关键字，需精确匹配）”以消除歧义。
- Around line 102-117: 将开头的绝对承诺“无损的 LLM 优化文档压缩。”改为弱化表述（例如“以无损为目标的 LLM
优化文档压缩”或“旨在实现无损的 LLM 优化文档压缩”），并在“验证”步骤里明确将往返重构验证标注为可执行命令（如“可通过 --validate
进行往返验证确认”），以避免先承诺无损再将验证设为可选导致的误解；更新标题句和“验证”小节文案（包含原句“无损的 LLM 优化文档压缩。”和“验证 —
往返重构测试，证明压缩无损”）以反映这一改动。
- Around line 276-293:
标题“生成或更新文件夹中所有文档的索引”与步骤中“扫描目标目录中所有非隐藏文件”的范围不一致且未定义安全边界；将两处措辞统一为明确的范围描述（例如“所有文本类文档”或“所有非隐藏、非二进制文档”），并在“工作原理”或“输入/输出”段落中添加明确的排除策略：按文件类型白名单/黑名单（例如排除二进制、数据库、证书）、最大文件大小阈值（例如
>10MB 跳过）和敏感文件名/路径模式（如 *.key, *.pem, .env, node_modules）过滤规则，确保生成的 index.md
仅包含安全且可索引的文档。
- Around line 265-273: Update the procedure to explicitly handle edge cases:
when no `##` headings exist, state the fallback (either error out with a clear
message or treat the whole file as a single section and still create
`index.md`), when duplicate `##` headings appear, define a disambiguation
strategy (e.g., append incremental suffixes like `-1`, `-2` or use
position-based prefixes to make `01-{section}.md`, `02-{section}.md` unique),
and when headings contain illegal filename characters, specify sanitization
rules (remove/replace characters and trim length) and how to reflect the
sanitized name in `index.md`; update the numbered steps and examples (references
to `index.md`, `01-{section}.md`, `02-{section}.md`) to document these behaviors
and expected error messages or warnings for skipped/failed sections.
---
Nitpick comments:
In `@docs/zh-cn/reference/core-tools.md`:
- Around line 10-12: Update the example invocation in
docs/zh-cn/reference/core-tools.md to use the project's standard slash-prefixed
skill syntax by replacing the bare token "bmad-help" with "/bmad-help" (keeping
the surrounding text and formatting intact) so IDE users can copy-paste the
correct invocation; ensure any other occurrences in the same file also follow
the "/<skill-name>" pattern.
- Line 195: 在现有描述只列出字段名的地方，补充一个包含单条记录的 JSON 最小示例，明确展示 location 的具体格式（例如
"file:path/to/file:line" 或 "path/to/file:lineNumber"）、trigger_condition
的示例字符串、guard_snippet 可以为 null 或字符串（示例中体现 null 情形以表明可空），以及 potential_consequence
的示例文本；确保示例包含字段 "location"、"trigger_condition"、"guard_snippet" 和
"potential_consequence" 并在说明中明确说明 location 格式规范和 guard_snippet 可为空以避免下游解析歧义。
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 976c40ab-a5a2-4cde-8d5a-a82eb10833e0
📒 Files selected for processing (1)
docs/zh-cn/reference/core-tools.md
Contributor
Contributor
|
@lrliang 已经建议合并这个分支. |
Collaborator
|
感谢你的 PR :) |
This was referenced Mar 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add Chinese translation for
docs/reference/core-tools.md, covering all 11 core tools.Why
Requested in #1972 by @cccczl to expand zh-cn documentation coverage.
How
Testing
markdownlintpasses with 0 errors.