docs(zh-cn-reference): refresh workflow and skills references#2100
docs(zh-cn-reference): refresh workflow and skills references#2100alexeyv merged 2 commits intobmad-code-org:mainfrom
Conversation
|
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 (4)
📝 WalkthroughWalkthroughChinese reference documentation updated to transition from slash-command terminology to skill-based naming. Content restructured across four files: agents.md adds Skill ID column and trigger-type distinctions; commands.md shifts focus from pre-built prompts to direct skill invocation and directory structure; core-tools.md condenses tool descriptions with streamlined inputs/outputs; workflow-map.md realigns workflow references and simplifies stage organization. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes 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 use your project's `biome` configuration to improve the quality of JS/TS/CSS/JSON code reviews.Add a configuration file to your project to customize how CodeRabbit runs |
🤖 Augment PR SummarySummary: This PR refreshes the Chinese (zh-cn) reference docs to better match the current BMad Method “skills + workflows” model and improve cross-page navigation. Changes:
Technical Notes: The docs emphasize regenerated skills via 🤖 Was this summary useful? React with 👍 or 👎 |
| ## 注意事项 | ||
| | 智能体 | Skill ID | 触发器 | 主要 workflow | | ||
| | --- | --- | --- | --- | | ||
| | Analyst (Mary) | `bmad-analyst` | `BP`、`RS`、`CB`、`DP` | Brainstorm、Research、Create Brief、Document Project | |
| | 智能体 | 触发器 | 你需要提供的内容 | | ||
| | --- | --- | --- | | ||
| | Technical Writer (Paige) | `WD` | 要撰写的文档主题与目标 | | ||
| | Technical Writer (Paige) | `US` | 要补充到标准中的偏好/规范 | |
| | --- | --- | --- | | ||
| | `bmad-brainstorming` | 通过引导式创意方法扩展方案空间 | `brainstorming-report.md` | | ||
| | `bmad-domain-research`、`bmad-market-research`、`bmad-technical-research` | 验证领域、市场与技术假设 | 研究发现 | | ||
| | `bmad-create-product-brief` | 沉淀产品方向与战略愿景 | `product-brief.md` | |
There was a problem hiding this comment.
|
Already fully checked, please @alexeyv merge. |
我统一修订中文 reference 中 workflow-map、commands、agents、core-tools 四页,改正过时命名与调用方式,并将术语切换到当前 skills 体系。此前这些页面混用了旧版前缀和命令语义,容易让用户在查阅阶段误用流程;现在页面结构与英文源和现行实现保持一致,同时优先串联中文路径以提升检索效率。 Feishu: https://feishu.cn/wiki/TODO Made-with: Cursor
8d525a1 to
6e57779
Compare
What
This PR updates four Chinese reference pages under
docs/zh-cn/reference/:workflow-map.mdcommands.mdagents.mdcore-tools.mdIt aligns workflow/skill naming with the current BMad conventions, removes outdated
bmad-bmm-*usage, improves cross-page Chinese navigation links, and keeps the reference tone concise and lookup-oriented.Why
The previous Chinese reference pages mixed legacy naming and older invocation semantics, which could mislead users when choosing workflows or calling skills. This change restores semantic parity with the current product behavior and reduces lookup friction for Chinese readers.
How
workflow-map.mdto reflect current phase workflows and outputs (includingbmad-sprint-statusandbmad-quick-devtrack).commands.mdas skills reference (generation model, storage paths, categories, troubleshooting) and aligned all examples to current skill IDs.agents.mdwithSkill IDmapping and trigger-type guidance, including conversational trigger examples.core-tools.mdinto a cleaner query-style reference across 11 built-in tools.:::form in this batch to avoid rendering/config drift risks.Testing
Ran
npm ci && npm run qualitysuccessfully.This includes format checks, linting, markdown lint, docs build, installation component tests, file-reference validation, and skill validation.