docs(zh-cn): align getting-started tutorial workflows#2093
docs(zh-cn): align getting-started tutorial workflows#2093alexeyv merged 3 commits intobmad-code-org:mainfrom
Conversation
我按英文源文更新中文入门教程中的命令、工作流和智能体调用方式, 并统一步骤叙述与导航语义,减少术语漂移和旧命令误导。 Feishu: https://www.feishu.cn/ Made-with: Cursor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated 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., Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 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)
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 CodeRabbit can generate a title for your PR based on the changes with custom instructions.Set the |
🤖 Augment PR SummarySummary: Updates the Chinese “Getting Started” tutorial to match the current BMAD onboarding flow and naming. Changes:
🤖 Was this summary useful? React with 👍 or 👎 |
| - **研究**(`bmad-bmm-research`) — 市场和技术研究 | ||
| - **创建产品简报**(`bmad-bmm-create-product-brief`) — 推荐的基础文档 | ||
| - **研究**(`bmad-research`) — 市场和技术研究 | ||
| - **创建产品简报**(`bmad-create-product-brief`) — 推荐的基础文档 |
There was a problem hiding this comment.
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
🤖 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
|
Already fully checked, please @alexeyv merge. |
What
This PR updates
docs/zh-cn/tutorials/getting-started.mdto improve clarity and execution consistency for first-time Chinese users. It aligns workflow commands and agent invocation patterns with the currentbmad-*naming and keeps semantic parity with the English source tutorial.Why
The previous Chinese tutorial still included legacy naming patterns (for example,
bmad-bmm-*andbmad-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)How
bmad-*conventions throughout the tutorial.Testing
Ran
npm ci && npm run qualitysuccessfully. This covers formatting, linting, docs build, installation component tests, reference validation, and skill validation.