Skip to content

docs(zh-cn): close Epic 4.5 explanation gaps#2102

Merged
alexeyv merged 1 commit intobmad-code-org:mainfrom
lrliang:docs/e4s5-cn-gap-closure
Mar 24, 2026
Merged

docs(zh-cn): close Epic 4.5 explanation gaps#2102
alexeyv merged 1 commit intobmad-code-org:mainfrom
lrliang:docs/e4s5-cn-gap-closure

Conversation

@lrliang
Copy link
Copy Markdown
Contributor

@lrliang lrliang commented Mar 22, 2026

What

This PR closes the confirmed Epic 4.5 gaps in Chinese explanation docs. It updates 9 docs/zh-cn/explanation pages to align command naming with the current bmad-* convention and adds Chinese-path cross-links so users can continue reading without falling into context dead ends.

本次 PR 对照 Epic 4.5 已确认缺口,对 9 篇 docs/zh-cn/explanation 页面做收口修订:统一命令命名到当前 bmad-* 约定,并补齐中文路径回链,避免阅读过程中出现上下文断层。

Why

After prior revisions, several explanation pages still had legacy command references, partial English labels in examples, and weak Chinese-page linkage. These issues make docs feel inconsistent and can interrupt a Chinese-only learning path.

在前序修订后,部分 explanation 页面仍残留旧命令名、示例中的半翻英文标签,以及中文页间串联不足的问题。这会造成术语不一致,也会打断中文用户的连续阅读路径。

How

  • Normalize legacy command mentions to current forms such as bmad-brainstorming, bmad-party-mode, and bmad-generate-project-context.
  • Localize half-translated role labels and tip title in party-mode examples.
  • Add contextual Chinese internal links across explanation pages to reconnect to related how-to and reference pages.
  • Apply a small clarity tweak by formatting localStorage as code in adversarial review examples.
  • 将旧命令写法统一为当前形式(如 bmad-brainstormingbmad-party-modebmad-generate-project-context)。
  • 修正 party-mode 示例中的半翻角色标签与提示标题。
  • 在 explanation 页面补充上下文相关的中文内部链接,回连到对应 how-toreference 页面。
  • 对对抗性评审示例做一处可读性微调:将 localStorage 以代码格式呈现。

Testing

Ran npm ci && npm run quality successfully.
This includes format checks, linting, markdown linting, docs build, installation component tests, reference validation, and skill validation.

已执行 npm ci && npm run quality,检查通过。覆盖格式检查、lint、Markdown lint、文档构建、安装组件测试、引用校验与技能校验。

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 22, 2026

🤖 Augment PR Summary

Summary: This PR updates zh-cn explanation docs to close the remaining Epic 4.5 gaps by aligning terminology and improving navigation.

Changes:

  • Normalize legacy command mentions to current bmad-* skill names (e.g., brainstorming, party mode, correct course, generate project context).
  • Localize partially-English speaker labels and tip title in the Party Mode examples.
  • Add contextual zh-cn internal links between explanation pages and related how-to/reference pages (incl. Workflow Map) to avoid dead ends.
  • Small readability tweak: render localStorage as inline code in adversarial review examples.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

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

Review completed. 2 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 22, 2026

📝 Walkthrough

Walkthrough

This PR updates Chinese documentation files across the explanation directory, standardizing workflow command names with bmad-* prefixes, localizing dialog labels to Chinese, and adding cross-reference links between related documentation pages to improve navigation and discoverability.

Changes

Cohort / File(s) Summary
Workflow Command Updates
brainstorming.md, party-mode.md, preventing-agent-conflicts.md, established-projects-faq.md, project-context.md
Standardize command references from plain names to bmad-* prefixed naming convention (e.g., brainstormingbmad-brainstorming, party-modebmad-party-mode). party-mode.md also includes extensive Chinese localization of speaker labels and role titles.
Documentation Navigation Enhancements
advanced-elicitation.md, quick-dev.md, why-solutioning-matters.md, adversarial-review.md
Add cross-reference links to related documentation pages and guidance on strategy positioning within the overall workflow, with minor inline formatting fixes (e.g., backtick wrapping for localStorage).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
  • alexeyv
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(zh-cn): close Epic 4.5 explanation gaps' directly and clearly summarizes the main change: closing documented gaps in Chinese explanation documentation for Epic 4.5.
Description check ✅ Passed The description provides comprehensive context about what gaps are being closed, why they matter for Chinese readers, and how the changes implement the closure—all directly related to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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/explanation/party-mode.md`:
- Line 29: Replace the phrase “有适当的回退机制” with a more natural Chinese expression
such as “能适当地回退” or “具备合理的回退机制” in the sentence containing “架构师:
'设计本身是合理的——分布式认证,有适当的回退机制。如果实现偏离了规范……'” so the line reads smoothly (e.g.,
“分布式认证,具备合理的回退机制”).
🪄 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: bc1d425f-9675-4406-a87b-15618fbeface

📥 Commits

Reviewing files that changed from the base of the PR and between e3f935f and 51b6d08.

📒 Files selected for processing (9)
  • docs/zh-cn/explanation/advanced-elicitation.md
  • docs/zh-cn/explanation/adversarial-review.md
  • docs/zh-cn/explanation/brainstorming.md
  • docs/zh-cn/explanation/established-projects-faq.md
  • docs/zh-cn/explanation/party-mode.md
  • docs/zh-cn/explanation/preventing-agent-conflicts.md
  • docs/zh-cn/explanation/project-context.md
  • docs/zh-cn/explanation/quick-dev.md
  • docs/zh-cn/explanation/why-solutioning-matters.md

@cccczl
Copy link
Copy Markdown
Contributor

cccczl commented Mar 23, 2026

Already fully checked, please @alexeyv merge.

我补齐 explanation 目录在本轮审校中确认的中文缺口,统一关键命令名为当前 `bmad-*` 形式,并修正 Party Mode 示例里的半翻角色标签。此前这些页面缺少回连到中文目标的入口且术语混用旧名,导致查阅路径容易断层;现在每页都补了中文回链并对齐命名,降低理解和跳转成本。

Feishu: https://feishu.cn/wiki/TODO
Made-with: Cursor
@alexeyv alexeyv force-pushed the docs/e4s5-cn-gap-closure branch from 51b6d08 to 3fb7a46 Compare March 24, 2026 08:30
@alexeyv alexeyv merged commit 090bfea into bmad-code-org:main Mar 24, 2026
5 checks passed
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