Skip to content

docs(zh-cn): refine install and non-interactive guides#2094

Merged
alexeyv merged 2 commits intobmad-code-org:mainfrom
lrliang:docs/e2s2-install-guides-cn
Mar 22, 2026
Merged

docs(zh-cn): refine install and non-interactive guides#2094
alexeyv merged 2 commits intobmad-code-org:mainfrom
lrliang:docs/e2s2-install-guides-cn

Conversation

@lrliang
Copy link
Copy Markdown
Contributor

@lrliang lrliang commented Mar 22, 2026

What

This PR updates two Chinese installation guides: docs/zh-cn/how-to/install-bmad.md and docs/zh-cn/how-to/non-interactive-installation.md. It standardizes installation wording, parameter terminology, and task flow, and adds clearer guidance for prerelease installs and skills enablement.

本次 PR 修订了 docs/zh-cn/how-to/install-bmad.mddocs/zh-cn/how-to/non-interactive-installation.md 两篇中文安装指南。重点是统一安装场景说明、参数术语和步骤表达,并补齐预发布安装与 skills 启用提示。

Why

The previous Chinese installation docs had inconsistencies in terminology and setup instructions across interactive vs non-interactive scenarios, which could cause user confusion during onboarding. This change improves executability and consistency while keeping semantic parity with the English source.
Fixes #issue_number (if applicable)

现有中文安装文档在术语、参数描述和安装路径表达上存在不一致,容易让用户在交互式与非交互式场景间产生理解偏差。该改动用于提升中文文档的可执行性与一致性,并与英文源文保持语义对齐。
Fixes #issue_number(如适用)

How

  • Refined the interactive install guide by adding @next prerelease install guidance, a skills enablement note, and a clearer “What You Get” structure section.
  • Standardized “flags/parameters” terminology in the non-interactive guide and improved validation/error-handling wording, including clearer Invalid directory troubleshooting.
  • Removed redundant glossary appendices from both pages to keep the how-to guides focused on actionable installation tasks.
  • 更新交互式安装指南文案:补充 @next 预发布安装说明、增加 skills 启用提示,并优化“你将获得”目录结构示例。
  • 统一非交互式安装文档中“标志/参数”表述,修正参数校验与错误处理章节,明确 Invalid directory 等常见问题提示。
  • 清理两篇文档末尾冗余术语附录,保持 how-to 文档聚焦于安装任务本身。

Testing

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

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

我统一中文安装文档中的术语和参数说明,补齐预发布安装与 skills 启用提示,
并保持交互式与非交互式安装路径和英文源文一致,减少安装场景下的理解偏差。

Feishu: https://www.feishu.cn/
Made-with: Cursor
@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Mar 22, 2026

🤖 Augment PR Summary

Summary: This PR refines the Chinese (zh-cn) interactive and non-interactive installation guides to reduce ambiguity and align terminology.
Changes:

  • Clarifies interactive install wording and adds prerelease install guidance via @next
  • Adds a note about enabling “skills” on platforms where it’s not shown by default
  • Standardizes “flags/parameters” terminology throughout the non-interactive guide and improves validation/troubleshooting phrasing
  • Updates the “What you get” directory tree example for current skills folder layouts
  • Removes redundant glossary appendices to keep pages task-focused

🤖 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

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: aefe6f28-7ba9-4a05-8997-36cee57309ad

📥 Commits

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

📒 Files selected for processing (2)
  • docs/zh-cn/how-to/install-bmad.md
  • docs/zh-cn/how-to/non-interactive-installation.md

📝 Walkthrough

Walkthrough

The PR updates Chinese-language documentation for the BMAD-METHOD installation process, revising terminology from "artifact" to "skills" integration, expanding prerelease version guidance with the @next flag, standardizing parameter and flag naming conventions, refining AI tool integration descriptions, and removing duplicate glossary sections.

Changes

Cohort / File(s) Summary
Chinese Installation Documentation
docs/zh-cn/how-to/install-bmad.md, docs/zh-cn/how-to/non-interactive-installation.md
Updated terminology and phrasing: replaced artifact references with skills-focused integration guidance, added prerelease version tip using npx bmad-method@next install, standardized parameter/flag naming, clarified validation and troubleshooting language, and removed redundant "术语说明" glossary sections from both files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: refining Chinese installation guides with improved wording and terminology standardization.
Description check ✅ Passed The description is directly related to the changeset, providing clear context on what was updated, why changes were needed, and how they were implemented.
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 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 biome.

我在安装指南中补充目录结构示例说明,明确工具相关目录会随所选平台变化,避免读者误以为 .claude/.cursor 一定同时存在。
我同时统一非交互式安装文档里残留的“标志”表述为“参数”,让术语在全文保持一致并降低理解成本。

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 ad2eb0e into bmad-code-org:main Mar 22, 2026
5 checks passed
@lrliang lrliang deleted the docs/e2s2-install-guides-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