Skip to content

docs(zh-cn): align getting-started tutorial workflows#2093

Merged
alexeyv merged 3 commits intobmad-code-org:mainfrom
lrliang:docs/e2s1-getting-started-cn
Mar 22, 2026
Merged

docs(zh-cn): align getting-started tutorial workflows#2093
alexeyv merged 3 commits intobmad-code-org:mainfrom
lrliang:docs/e2s1-getting-started-cn

Conversation

@lrliang
Copy link
Copy Markdown
Contributor

@lrliang lrliang commented Mar 22, 2026

What

This PR updates docs/zh-cn/tutorials/getting-started.md to improve clarity and execution consistency for first-time Chinese users. It aligns workflow commands and agent invocation patterns with the current bmad-* naming and keeps semantic parity with the English source tutorial.

本次 PR 修订了 docs/zh-cn/tutorials/getting-started.md,统一中文入门教程的表达与执行指引。重点是将教程中的命令、工作流与智能体调用方式对齐到当前可用的 bmad-* 体系,并与英文源文保持语义一致。

Why

The previous Chinese tutorial still included legacy naming patterns (for example, bmad-bmm-* and bmad-agent-bmm-*), which could mislead new users during onboarding. This change ensures the tutorial is readable, executable, and consistent with the canonical English flow.
Fixes #issue_number (if applicable)

现有中文入门教程中存在旧命名(如 bmad-bmm-* / bmad-agent-bmm-*)和表述漂移,容易让首次使用者在执行流程时产生误解。该改动用于确保“可读、可执行、可对照英文源文”,减少新手上手成本。
Fixes #issue_number(如适用)

How

  • Replaced legacy command/agent naming with the current bmad-* conventions throughout the tutorial.
  • Updated phase guidance, quick-reference table, and FAQ terminology to match the English source flow and sequence.
  • Removed the extra glossary section at the end to keep the tutorial focused and within source parity scope.
  • 统一更新教程中的命令与调用方式,将旧命名替换为当前 bmad-* 命名。
  • 修订阶段说明、快速参考表与 FAQ 中的关键术语,保持流程顺序与英文源文一致。
  • 清理教程末尾冗余术语附录,避免教程内容超出源文范围并降低阅读噪音。

Testing

Ran npm ci && npm run quality successfully. This covers formatting, linting, docs build, installation component tests, reference validation, and skill validation.

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

我按英文源文更新中文入门教程中的命令、工作流和智能体调用方式,
并统一步骤叙述与导航语义,减少术语漂移和旧命令误导。

Feishu: https://www.feishu.cn/
Made-with: Cursor
@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: a8239f50-e204-4ec6-8319-de8dc34f072b

📥 Commits

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

📒 Files selected for processing (1)
  • docs/zh-cn/tutorials/getting-started.md

📝 Walkthrough

Walkthrough

Updated the Chinese getting-started tutorial to transition command examples from IDE-style slash commands to direct skill name invocation, renamed references to align with new BMad skill conventions (e.g., bmad-prd, bmad-quick-dev), added @next pre-release installation documentation, and removed the glossary section.

Changes

Cohort / File(s) Summary
Chinese Tutorial Documentation
docs/zh-cn/tutorials/getting-started.md
Replaced slash command examples (e.g., /bmad-help) with direct skill invocation syntax; updated legacy bmad-bmm-* and bmad-agent-bmm-* references to new skill names; added @next pre-release channel installation instructions; removed glossary (术语说明) section; adjusted capability scope language.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Possibly related issues

  • Issue #1978: Updates zh-cn getting-started page content and command names, directly addressing the documented need for README_CN.md to link to this tutorial URL.

Possibly related PRs

  • PR #1892: Makes identical code-level documentation changes removing leading slashes and switching to direct skill name invocation in getting-started and related docs.
  • PR #1850: Renames command/slash-command references to new skill names with updates in the getting-started tutorial.
  • PR #1893: Removes leading slashes from skill/command examples in Chinese documentation with overlapping content changes.

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs(zh-cn): align getting-started tutorial workflows' clearly and concisely summarizes the main change: updating the Chinese Getting Started tutorial to align workflows with current naming conventions.
Description check ✅ Passed The description is clearly related to the changeset, providing context about legacy naming issues, the rationale for alignment with current bmad-* conventions, and testing confirmation.
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.

Tip

CodeRabbit can generate a title for your PR based on the changes with custom instructions.

Set the reviews.auto_title_instructions setting to generate a title for your PR based on the changes in the PR with custom instructions.

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 22, 2026

🤖 Augment PR Summary

Summary: Updates the Chinese “Getting Started” tutorial to match the current BMAD onboarding flow and naming.

Changes:

  • Replaces legacy bmad-bmm-* / bmad-agent-bmm-* references with the current bmad-* skill/workflow names.
  • Aligns phase guidance, workflow invocation wording, quick-reference table entries, and FAQ terminology with the English tutorial.
  • Adds an install note for using the prerelease channel via npx bmad-method@next install.
  • Removes the trailing glossary section to keep parity and reduce onboarding noise.

🤖 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.

- **研究**(`bmad-bmm-research`) — 市场和技术研究
- **创建产品简报**(`bmad-bmm-create-product-brief`) — 推荐的基础文档
- **研究**(`bmad-research`) — 市场和技术研究
- **创建产品简报**(`bmad-create-product-brief`) — 推荐的基础文档
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This references bmad-create-product-brief, but the workflow skill in src/bmm-skills/1-analysis/ is bmad-product-brief (and its manifest indicates it replaces bmad-create-product-brief). Worth double-checking the user-facing command/alias so the tutorial stays executable.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

我将入门教程阶段 1 中过时或不可用的技能名替换为当前可调用的技能名。
此前 `bmad-research` 与 `bmad-create-product-brief` 可能导致新用户执行受阻;现在改为具体研究技能与 `bmad-product-brief`,提升教程可执行性。

Feishu: <https://www.feishu.cn/>
Made-with: Cursor
@cccczl
Copy link
Copy Markdown
Contributor

cccczl commented Mar 22, 2026

Already fully checked, please @alexeyv merge.

@alexeyv alexeyv merged commit ba2a5cc into bmad-code-org:main Mar 22, 2026
5 checks passed
@lrliang lrliang deleted the docs/e2s1-getting-started-cn branch March 24, 2026 07:28
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