Skip to content

docs(zh-cn): refine established project guides#2096

Merged
alexeyv merged 3 commits intobmad-code-org:mainfrom
lrliang:docs/e2s4-established-context-cn
Mar 22, 2026
Merged

docs(zh-cn): refine established project guides#2096
alexeyv merged 3 commits intobmad-code-org:mainfrom
lrliang:docs/e2s4-established-context-cn

Conversation

@lrliang
Copy link
Copy Markdown
Contributor

@lrliang lrliang commented Mar 22, 2026

What

This PR updates two Chinese guides: docs/zh-cn/how-to/established-projects.md and docs/zh-cn/how-to/project-context.md. It clarifies established-project onboarding vs new-project paths, refreshes workflow command references, and aligns key terminology around project context and architecture.

本次 PR 修订了 docs/zh-cn/how-to/established-projects.mddocs/zh-cn/how-to/project-context.md 两篇中文指南。重点是明确既有项目接入与新项目路径边界,更新工作流命令引用,并统一 project context 与 architecture 等关键术语表达。

Why

The previous Chinese guides mixed older invocation patterns and inconsistent terms, which could cause confusion when users decide between new-project and established-project workflows. This change improves executability and keeps semantic alignment with the current English-source conventions.
Fixes #issue_number (if applicable)

现有中文指南中存在旧命令调用方式与术语不一致的问题,用户在“新项目/既有项目”流程选择上容易产生理解偏差。该改动用于提升文档可执行性,并与当前英文源文规范保持语义一致。
Fixes #issue_number(如适用)

How

  • Reworked the established-project guide to clearly separate “new project” and “existing codebase” usage, and updated workflow calls to current command names.
  • Updated the project-context guide with current command references (bmad-generate-project-context), clearer usage pathways, and a more actionable verification/tips structure.
  • Standardized terminology across both pages (e.g., project context, architecture, story) and removed glossary-heavy appendices to keep guidance focused on concrete next actions.
  • 重构既有项目指南,明确区分“新项目”与“现有代码库”使用路径,并将工作流调用更新为当前命令名。
  • 更新项目上下文指南的命令引用(bmad-generate-project-context),并优化使用路径、验证步骤与提示结构,使其更可执行。
  • 在两篇文档间统一术语(如 project context、architecture、story),并移除附录式术语段,保持文档聚焦具体下一步动作。

Testing

Ran npm ci && npm run quality successfully on this branch before push. This includes format checks, linting, markdown lint, docs build, installation component tests, reference validation, and skill validation.

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

clarify the boundary between new-project and established-project usage so zh-cn readers can choose the right workflow path.
align project context terminology and command references with current conventions while keeping guidance concise and executable.

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

augmentcode bot commented Mar 22, 2026

🤖 Augment PR Summary

Summary: Refines two zh-cn guides to better support onboarding for established codebases and align terminology with current BMad docs.

Changes:

  • Clarifies “new project” vs “existing codebase” paths and points new users to the quickstart.
  • Updates workflow/task invocation examples to current names (e.g., bmad-generate-project-context, bmad-document-project, bmad-help).
  • Reorders and tightens the established-project steps (cleanup → project context → documentation → help/next actions).
  • Reworks the project-context guide into clearer creation paths (manual / after architecture / for existing projects).
  • Adds concrete verification guidance and “best practices” tips for keeping context lean and accurate.
  • Standardizes key terms (project context, architecture, story) and removes glossary-style appendices to keep docs action-oriented.

Technical Notes: Documentation-only change intended to reduce confusion from older command patterns and inconsistent wording; validates via the repo’s npm run quality pipeline per PR description.

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

📝 Walkthrough

Walkthrough

Updated two Chinese documentation files for project-context and established-projects guides. Changed command names and workflow references, refined wording for consistency, updated admonition syntax, and removed terminology explanation sections.

Changes

Cohort / File(s) Summary
Chinese documentation updates
docs/zh-cn/how-to/established-projects.md, docs/zh-cn/how-to/project-context.md
Updated command from /bmad-bmm-generate-project-context to bmad-generate-project-context and workflow from document-project to bmad-document-project. Refined wording throughout for consistency, changed admonition block syntax (::: note to :::: note), consolidated multiple tip blocks, updated section headers with explicit labels (e.g., "(project context)", "(architecture)"), and removed "术语说明" sections from both files.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: refining Chinese guides for established projects, which aligns with the primary objectives of updating two Chinese documentation files.
Description check ✅ Passed The description clearly explains what was changed (two Chinese guides), why it was needed (clarify paths, fix outdated commands, standardize terminology), how it was addressed, and testing performed.
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 TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/zh-cn/how-to/project-context.md`:
- Line 23: Update the sentence "发现智能体在不同用户故事(story)间决策不一致" to use more natural
Chinese phrasing—replace it with either "发现智能体在不同用户故事(story)之间决策不一致" or
"发现智能体在不同用户故事(story)中决策不一致" so the wording reads fluently; modify the string
exactly where that sentence appears in the document.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 420280dd-a486-43f0-bc3e-8a4839575cd8

📥 Commits

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

📒 Files selected for processing (2)
  • docs/zh-cn/how-to/established-projects.md
  • docs/zh-cn/how-to/project-context.md

我将 project-context 文档中的提示块语法统一回项目规范的 `:::...:::` 形式,避免与文档风格约定不一致。
我同时把“在不同用户故事(story)间决策不一致”调整为“之间决策不一致”,提升中文表达的自然度与可读性。

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 76fb7e0 into bmad-code-org:main Mar 22, 2026
5 checks passed
@lrliang lrliang deleted the docs/e2s4-established-context-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