fix(i18n): point zh-cn doc links to Chinese pages instead of English#2010
Merged
bmadcode merged 1 commit intobmad-code-org:mainfrom Mar 15, 2026
Merged
fix(i18n): point zh-cn doc links to Chinese pages instead of English#2010bmadcode merged 1 commit intobmad-code-org:mainfrom
bmadcode merged 1 commit intobmad-code-org:mainfrom
Conversation
将 README_CN.md 和 docs/zh-cn/ 中指向英文页面的链接替换为对应的中文版本， 对无中文版的外部链接添加（英文）标注，修正链接文字与目标不匹配的问题， 移除 project-context.md 中的自引用链接。 Fixes bmad-code-org#1978 Made-with: Cursor
📝 WalkthroughWalkthroughUpdates Chinese documentation links to point to zh-cn localized paths instead of English equivalents, and adds language indicators (（英文）) to denote English-only links. Also adjusts link formatting in zh-cn documentation files for consistency. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 You can customize the high-level summary generated by CodeRabbit.Configure the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (6)
docs/zh-cn/explanation/project-context.md (2)
8-8: Define canonical file location at first mention to reduce ambiguity.First mention should include
_bmad-output/project-context.md(or explicit default path) so readers don’t infer arbitrary locations from repeated bare filename mentions.Also applies to: 33-33
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh-cn/explanation/project-context.md` at line 8, Update the first mention of `project-context.md` to include the canonical file path `_bmad-output/project-context.md` (or the explicit default path) so readers know the exact location; locate the initial reference in the document text and replace the bare filename with `_bmad-output/project-context.md`, and make the same change for the other occurrence noted (line 33) to ensure consistency throughout.
8-8: You removed all clickable references; keep one canonical link for discoverability.Inline code is cleaner, but removing every link makes source-view navigation worse. Keep the first occurrence as a link, then use inline code afterward.
Based on learnings: Treat
project-context.mdas a singleton metadata file and keep references unambiguous across workflows.Also applies to: 17-17, 21-21, 33-33, 130-130, 146-146
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh-cn/explanation/project-context.md` at line 8, Restore one canonical clickable reference for the singleton metadata file `project-context.md`: keep the very first occurrence as an actual hyperlink (so readers in source view can navigate), and convert all subsequent mentions of `project-context.md` to inline code formatting; ensure the file is treated as a single authoritative reference across workflows by leaving that first link intact and making other references unambiguous inline mentions.docs/zh-cn/index.md (1)
11-11: Avoid root-absolute link for roadmap in docs markdown.
/zh-cn/roadmap/assumes site root mounting. Use doc-relative linking to keep local/preview builds portable.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh-cn/index.md` at line 11, The markdown uses an absolute site-root link '/zh-cn/roadmap/' which breaks local/preview builds; update the link in the line containing "/zh-cn/roadmap/" to a doc-relative link (e.g. "./roadmap/" or "roadmap/") so the anchor remains portable during local preview and when mounted under a subpath.README_CN.md (2)
23-23: Prefer relative internal links over hardcoded domain URLs.These are internal docs links; hardcoding hostnames makes forks, preview deployments, and domain migrations brittle.
Proposed refactor
-[在 **docs.bmad-method.org** 了解更多](https://docs.bmad-method.org/zh-cn/) +[在 **docs.bmad-method.org** 了解更多](/zh-cn/) -**[📍 查看完整路线图 →](https://docs.bmad-method.org/zh-cn/roadmap/)** +**[📍 查看完整路线图 →](/zh-cn/roadmap/)** -[查看非交互式安装选项](https://docs.bmad-method.org/zh-cn/how-to/non-interactive-installation/) +[查看非交互式安装选项](/zh-cn/how-to/non-interactive-installation/) -[BMad 方法文档站点](https://docs.bmad-method.org/zh-cn/) — 教程、指南、概念和参考 +[BMad 方法文档站点](/zh-cn/) — 教程、指南、概念和参考 -- [入门教程](https://docs.bmad-method.org/zh-cn/tutorials/getting-started/) -- [从先前版本升级](https://docs.bmad-method.org/zh-cn/how-to/upgrade-to-v6/) +- [入门教程](/zh-cn/tutorials/getting-started/) +- [从先前版本升级](/zh-cn/how-to/upgrade-to-v6/)Also applies to: 31-31, 53-53, 71-71, 74-75
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README_CN.md` at line 23, Replace hardcoded absolute docs URLs like "https://docs.bmad-method.org/zh-cn/" used in link texts such as "[在 **docs.bmad-method.org** 了解更多]" with relative internal links (for example "/zh-cn/" or the appropriate relative docs path) so forks and preview deployments work; apply the same change for the other occurrences that use the docs.bmad-method.org hostname (the links referenced at the other lines), ensuring the markdown link targets are relative rather than domain-prefixed.
23-23: Stop repeating raw URLs; use reference-style links for safer maintenance.Same host/path pattern appears repeatedly. One update currently requires editing multiple lines and invites drift.
Also applies to: 31-31, 53-53, 71-71, 74-76
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README_CN.md` at line 23, Replace repeated inline raw URLs with a single reference-style link: update each occurrence of the link text like "在 **docs.bmad-method.org** 了解更多" (and the other identical host/path occurrences) to use a reference label (e.g. [docs-bmad]) and add one reference definition at the end of the document such as "[docs-bmad]: https://docs.bmad-method.org/zh-cn/" so future host/path changes only require editing that single reference; ensure all matching raw URLs in the file are replaced with the same reference label to avoid duplication.docs/zh-cn/reference/testing.md (1)
68-68: Use a task-relevant deep link instead of the TEA homepage.This points to the docs root, which adds extra navigation steps. Link to the specific TEA section (testing strategy/workflows) if available.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/zh-cn/reference/testing.md` at line 68, Replace the generic TEA homepage link on the line containing "**文档：** [TEA 模块文档（英文）](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)" with a task-relevant deep link to the specific TEA section covering testing strategy or workflows (e.g., the testing strategy page or workflows subsection) so readers land directly on the testing content; locate the markdown line that begins with "**文档：**" and update the URL to the appropriate TEA testing section.
🤖 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/index.md`:
- Line 38: Update the link label text in docs/zh-cn/index.md where the BMad
Builder link currently reads "BMad Builder（英文）": change it to explicitly
indicate there is no Chinese localization (e.g. "BMad Builder（英文，暂无中文页）") so
Chinese readers understand the target site lacks a Chinese version; ensure you
keep the existing URL and formatting unchanged and only modify the visible label
text around "BMad Builder（英文）".
In `@docs/zh-cn/reference/testing.md`:
- Line 68: Add a docs lint rule named enforceZhCnEnglishLinks that runs during
the docs lint pipeline and scans all Markdown under the zh-cn docs set for
external links (href starts with http:// or https://), flagging any link whose
link text does not contain the exact marker "（英文）"; implement it as a
remark/markdownlint plugin (or add to the existing docsLintRules/remarkPlugins
list) so it returns a diagnostic with the file and link location, and wire this
rule into the CI docs check so future PRs fail when an external link in the
zh-cn content is missing the "（英文）" marker.
In `@README_CN.md`:
- Around line 74-76: Update the three quick links in README_CN.md so the
localized (Chinese) links explicitly indicate the locale: change the link text
"入门教程" to "入门教程（中文）" and "从先前版本升级" to "从先前版本升级（中文）", leaving "测试架构师文档（英文）"
as-is; i.e., modify the Markdown link labels for the two Chinese entries to
include the "（中文）" suffix so language context is consistent.
---
Nitpick comments:
In `@docs/zh-cn/explanation/project-context.md`:
- Line 8: Update the first mention of `project-context.md` to include the
canonical file path `_bmad-output/project-context.md` (or the explicit default
path) so readers know the exact location; locate the initial reference in the
document text and replace the bare filename with
`_bmad-output/project-context.md`, and make the same change for the other
occurrence noted (line 33) to ensure consistency throughout.
- Line 8: Restore one canonical clickable reference for the singleton metadata
file `project-context.md`: keep the very first occurrence as an actual hyperlink
(so readers in source view can navigate), and convert all subsequent mentions of
`project-context.md` to inline code formatting; ensure the file is treated as a
single authoritative reference across workflows by leaving that first link
intact and making other references unambiguous inline mentions.
In `@docs/zh-cn/index.md`:
- Line 11: The markdown uses an absolute site-root link '/zh-cn/roadmap/' which
breaks local/preview builds; update the link in the line containing
"/zh-cn/roadmap/" to a doc-relative link (e.g. "./roadmap/" or "roadmap/") so
the anchor remains portable during local preview and when mounted under a
subpath.
In `@docs/zh-cn/reference/testing.md`:
- Line 68: Replace the generic TEA homepage link on the line containing "**文档：**
[TEA
模块文档（英文）](https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/)"
with a task-relevant deep link to the specific TEA section covering testing
strategy or workflows (e.g., the testing strategy page or workflows subsection)
so readers land directly on the testing content; locate the markdown line that
begins with "**文档：**" and update the URL to the appropriate TEA testing section.
In `@README_CN.md`:
- Line 23: Replace hardcoded absolute docs URLs like
"https://docs.bmad-method.org/zh-cn/" used in link texts such as "[在
**docs.bmad-method.org** 了解更多]" with relative internal links (for example
"/zh-cn/" or the appropriate relative docs path) so forks and preview
deployments work; apply the same change for the other occurrences that use the
docs.bmad-method.org hostname (the links referenced at the other lines),
ensuring the markdown link targets are relative rather than domain-prefixed.
- Line 23: Replace repeated inline raw URLs with a single reference-style link:
update each occurrence of the link text like "在 **docs.bmad-method.org** 了解更多"
(and the other identical host/path occurrences) to use a reference label (e.g.
[docs-bmad]) and add one reference definition at the end of the document such as
"[docs-bmad]: https://docs.bmad-method.org/zh-cn/" so future host/path changes
only require editing that single reference; ensure all matching raw URLs in the
file are replaced with the same reference label to avoid duplication.
🪄 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: 580fdd2b-82a6-4e6c-86a1-66912eab1d66
📒 Files selected for processing (4)
README_CN.mddocs/zh-cn/explanation/project-context.mddocs/zh-cn/index.mddocs/zh-cn/reference/testing.md
Contributor
|
@lrliang Thanks a lot for the correction. I have reviewed it. Please ask @alexeyv to merge. @lrliang @MenglongFan I am very glad to cooperate with both of you to promote Chinese support for the BMAD-METHOD documentation. We will try our best to keep the translation faithful to the original. If translating specific terms would disrupt the reading flow or cause ambiguity, we will add explanations at the bottom of the page. If you need timely communication, you can add my WeChat (cccczl); we have organized a small support group. |
bmadcode
approved these changes
Mar 15, 2026
This was referenced Mar 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
将 README_CN.md 和 docs/zh-cn/ 中指向英文页面的链接替换为对应的中文版本， 对无中文版的外部链接添加（英文）标注，修正链接文字与目标不匹配的问题，
移除 project-context.md 中的自引用链接。
What
Fix 16 link issues across 4 Chinese documentation files where links incorrectly pointed to English pages.
Why
Chinese readers were silently dropped onto English documentation pages. Fixes #1978.
How
（英文）hint to TEA docs link, fix misleading link text (查看所有安装选项→查看非交互式安装选项)/zh-cn/roadmap/, add（英文）to BMad Builder link（英文）to TEA module docs link[project-context.md](project-context.md)→ plain`project-context.md`(matches English original)Testing
markdownlintpasses with 0 errors on all 4 modified files.