docs(zh-cn): refine established project guides#2096
docs(zh-cn): refine established project guides#2096alexeyv merged 3 commits intobmad-code-org:mainfrom
Conversation
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
🤖 Augment PR SummarySummary: Refines two zh-cn guides to better support onboarding for established codebases and align terminology with current BMad docs. Changes:
Technical Notes: Documentation-only change intended to reduce confusion from older command patterns and inconsistent wording; validates via the repo’s 🤖 Was this summary useful? React with 👍 or 👎 |
📝 WalkthroughWalkthroughUpdated 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
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
🚥 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 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. |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
docs/zh-cn/how-to/established-projects.mddocs/zh-cn/how-to/project-context.md
我将 project-context 文档中的提示块语法统一回项目规范的 `:::...:::` 形式,避免与文档风格约定不一致。 我同时把“在不同用户故事(story)间决策不一致”调整为“之间决策不一致”,提升中文表达的自然度与可读性。 Feishu: <https://www.feishu.cn/> Made-with: Cursor
|
Already fully checked, please @alexeyv merge. |
What
This PR updates two Chinese guides:
docs/zh-cn/how-to/established-projects.mdanddocs/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.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)How
bmad-generate-project-context), clearer usage pathways, and a more actionable verification/tips structure.Testing
Ran
npm ci && npm run qualitysuccessfully on this branch before push. This includes format checks, linting, markdown lint, docs build, installation component tests, reference validation, and skill validation.