Skip to content

docs(zh-cn): refresh epic4 stories 4.3-4.4 pages#2101

Merged
alexeyv merged 1 commit intobmad-code-org:mainfrom
lrliang:docs/e4s3-s4s4-cn-reference-roadmap
Mar 24, 2026
Merged

docs(zh-cn): refresh epic4 stories 4.3-4.4 pages#2101
alexeyv merged 1 commit intobmad-code-org:mainfrom
lrliang:docs/e4s3-s4s4-cn-reference-roadmap

Conversation

@lrliang
Copy link
Copy Markdown
Contributor

@lrliang lrliang commented Mar 22, 2026

What

This PR updates four Chinese docs for Epic 4 stories 4.3 and 4.4:

  • docs/zh-cn/reference/modules.md
  • docs/zh-cn/reference/testing.md
  • docs/zh-cn/roadmap.mdx
  • docs/zh-cn/_STYLE_GUIDE.md

It refreshes module/testing references, aligns roadmap wording with current terminology, and updates the Chinese style guide so structure rules remain actionable.

本次 PR 修订 Epic 4 的 4.3 与 4.4 对应 4 个中文页面:modules.mdtesting.mdroadmap.mdx_STYLE_GUIDE.md。重点是更新模块/测试参考信息、统一路线图术语表达,并重构中文风格指南使其规则可直接执行。

Why

The previous Chinese pages had outdated naming, mixed terminology, and uneven style-guide clarity, which could mislead users when selecting modules, understanding test boundaries, or contributing docs. This change improves semantic accuracy and consistency with current BMad workflows.

旧版中文页面存在命名过时、术语混用与规范描述不清的问题,容易在模块选型、测试能力边界和文档协作时产生误解。本次改动用于提升语义准确性,并与当前 BMad 工作流保持一致。

How

  • Rewrote modules.md with clearer module boundaries (bmb/cis/gds/tea) and explicit English-resource labels for external docs.
  • Rewrote testing.md to compare Quinn vs TEA, corrected current trigger/skill names, and clarified the Phase-4 testing sequence.
  • Updated roadmap.mdx wording to be concise and consistent with site terminology.
  • Reworked zh-cn/_STYLE_GUIDE.md into an actionable Chinese guide, including standardized admonition examples with ::: syntax.
  • 重写 modules.md:明确 bmb/cis/gds/tea 能力边界,并对外部文档统一标注英文资源。
  • 重写 testing.md:梳理 Quinn 与 TEA 的差异,修正当前触发器/skill 命名,并澄清阶段 4 的测试串联顺序。
  • 优化 roadmap.mdx:统一术语与叙述密度,使中文表达更自然、可读。
  • 重构 zh-cn/_STYLE_GUIDE.md:转为可执行的中文规范,并在示例中统一 ::: 提示块语法。

Testing

Ran npm ci && npm run quality successfully.
This includes format checks, linting, markdown lint, docs build, installation component tests, file-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 refreshes several zh-cn documentation pages for Epic 4 stories 4.3–4.4 to remove outdated naming and improve terminology consistency.

Changes:

  • Rewrites docs/zh-cn/reference/modules.md with a clearer module overview (bmb/cis/gds/tea), updated capability boundaries, and explicit English-labeled external resources.
  • Reworks docs/zh-cn/reference/testing.md to compare Quinn vs TEA, update current trigger/skill names, and clarify the Phase-4 testing sequence in the workflow map.
  • Edits docs/zh-cn/roadmap.mdx for more concise, site-aligned wording and more consistent use of terms like “skill/workflow”.
  • Refactors docs/zh-cn/_STYLE_GUIDE.md into a more actionable Chinese guide with standardized Starlight ::: admonition examples and updated tables/templates.

Technical Notes: The updated Chinese docs align with current installer-generated skill IDs (e.g., bmad-qa-generate-e2e-tests, bmad-correct-course) and keep cross-references within the docs/zh-cn/reference section consistent.

🤖 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. No suggestions at this time.

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

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8840466b-486d-40b8-8ece-3b0f47c5c749

📥 Commits

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

📒 Files selected for processing (4)
  • docs/zh-cn/_STYLE_GUIDE.md
  • docs/zh-cn/reference/modules.md
  • docs/zh-cn/reference/testing.md
  • docs/zh-cn/roadmap.mdx

📝 Walkthrough

Walkthrough

This pull request updates Chinese documentation across the BMad Method project. Changes include translating the style guide to Chinese, restructuring module reference documentation with updated capability lists and resource links, redesigning testing documentation with revised comparison frameworks between Quinn and TEA, and updating the public roadmap with refined terminology and rewritten descriptions.

Changes

Cohort / File(s) Summary
Documentation Translation
docs/zh-cn/_STYLE_GUIDE.md
Translated style guide content from English to Chinese, including headings, rule tables, templates, and examples. Updated command/workflow references (e.g., correct-coursebmad-correct-course).
Module Reference Restructuring
docs/zh-cn/reference/modules.md
Consolidated module descriptions into a single overview table, redesigned per-module sections with updated capability lists and external resource links, removed community modules section, and added module selection guidance.
Testing Documentation Redesign
docs/zh-cn/reference/testing.md
Restructured Quinn and TEA comparison dimensions, repositioned Quinn as a built-in agent with clarified scope boundaries, reorganized TEA workflows into simplified table format, replaced testing workflow integration section with stage-specific placement guidance, and removed terminology section.
Roadmap Updates
docs/zh-cn/roadmap.mdx
Updated page metadata, revised heading from "BMad 方法:公开路线图" to "BMad Method 公开路线图", standardized terminology across roadmap cards (e.g., "Skills" instead of "技能架构"), adjusted feature descriptions and call-to-action text, and removed terminology section.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • alexeyv
  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating four Chinese documentation pages for Epic 4 stories 4.3-4.4.
Description check ✅ Passed The description is directly related to the changeset, providing clear what/why/how context for updates to the four Chinese documentation pages.
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.

@cccczl
Copy link
Copy Markdown
Contributor

cccczl commented Mar 23, 2026

Already fully checked, please @alexeyv merge.

我统一修订中文模块与测试参考、路线图和文档风格指南,确保模块边界、测试能力、术语和跳转在中文站点内一致。此前这些页面存在命名过时、语气不统一和提示块语法不稳定的问题;现在我改为当前 skills/workflow 语义,并明确英文外部资源边界与 `:::` 提示块规范,以降低查阅和贡献时的歧义成本。

Feishu: https://feishu.cn/wiki/TODO
Made-with: Cursor
@alexeyv alexeyv force-pushed the docs/e4s3-s4s4-cn-reference-roadmap branch from e893f75 to b373fd1 Compare March 24, 2026 05:33
@alexeyv alexeyv merged commit c350e5b into bmad-code-org:main Mar 24, 2026
5 checks passed
@lrliang lrliang deleted the docs/e4s3-s4s4-cn-reference-roadmap branch March 24, 2026 07:29
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