Skip to content

docs(vi-vn): sync translations and add missing checkpoint-preview page#2222

Open
miendinh wants to merge 2 commits intobmad-code-org:mainfrom
miendinh:docs/vi-vn-update-translations
Open

docs(vi-vn): sync translations and add missing checkpoint-preview page#2222
miendinh wants to merge 2 commits intobmad-code-org:mainfrom
miendinh:docs/vi-vn-update-translations

Conversation

@miendinh
Copy link
Copy Markdown
Contributor

@miendinh miendinh commented Apr 6, 2026

What

Updated and expanded the Vietnamese documentation to match recent upstream doc changes, including syncing existing translations and adding the missing checkpoint-preview page.
Also localized several remaining mixed-language Vietnamese titles and body sections so the vi-vn docs read more consistently.

Why

The recent upstream pull introduced new and updated documentation that was not yet reflected in the Vietnamese docs.
This change keeps the vi-vn docs complete, reduces fallback-to-English gaps, and improves consistency for Vietnamese readers.

How

  • Synced README_VN.md and the Vietnamese get-answers-about-bmad page with the latest upstream documentation changes.
  • Added the missing Vietnamese translation for the checkpoint-preview explanation page so the /vi-vn/... route has localized content.
  • Localized remaining mixed English/Vietnamese titles and key body content in high-traffic vi-vn docs for more consistent terminology and navigation labels.

Testing

Ran markdownlint on the updated Vietnamese markdown files and verified there were no diagnostics errors.
Built the docs site with npm run docs:build and confirmed the Vietnamese routes, including checkpoint-preview, were generated successfully.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 6, 2026

📝 Walkthrough

Walkthrough

This PR updates Vietnamese language documentation throughout the repository, including translating English document titles to Vietnamese, standardizing Vietnamese terminology, restructuring the get-answers guide, and updating the Vietnamese README with new prerequisites and community links.

Changes

Cohort / File(s) Summary
Vietnamese Frontmatter Title Translations
docs/vi-vn/explanation/party-mode.md, docs/vi-vn/how-to/project-context.md, docs/vi-vn/how-to/quick-fixes.md, docs/vi-vn/reference/agents.md, docs/vi-vn/reference/commands.md
Document titles translated from English to Vietnamese in frontmatter (e.g., "Party Mode" → "Chế độ Party", "Agents" → "Các agent").
Documentation Terminology & Content Rewrites
docs/vi-vn/explanation/analysis-phase.md, docs/vi-vn/explanation/quick-dev.md, docs/vi-vn/reference/core-tools.md, docs/vi-vn/reference/workflow-map.md
Vietnamese terminology standardized throughout (e.g., "analysis" → "phân tích", "Brainstorming" → "động não", "workflow" → "quy trình") with corresponding heading and content updates.
Vietnamese README Updates
README_VN.md
Added Python (>=3.10) and uv badges and prerequisites; updated community section with YouTube, X/Twitter, and website links; simplified support section with email contact for enterprise sponsorship.
How-To Guide Restructure
docs/vi-vn/how-to/get-answers-about-bmad.md
Condensed and reorganized guidance from detailed step-by-step workflow to shorter, focused steps emphasizing bmad-help as the fastest path, with simplified community channel references and removed qualifiers.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

Suggested reviewers

  • bmadcode
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: Vietnamese documentation synchronization, translation localization, and addition of a missing checkpoint-preview page.
Description check ✅ Passed The description clearly relates to the changeset by explaining what was updated (Vietnamese docs sync, new checkpoint-preview page, localization), why (keeping docs complete), how (syncing files, adding missing translations), 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.

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.

🧹 Nitpick comments (2)
README_VN.md (2)

85-85: Consider localizing "master class" to Vietnamese.

The term "master class" is English in an otherwise Vietnamese document. Per the PR objectives to "localize remaining mixed English/Vietnamese" content, consider translating it to "lớp học chuyên sâu" or "khóa học nâng cao" for consistency.

🌐 Proposed localization
-- [YouTube](https://youtube.com/@BMadCode) - Video hướng dẫn, master class và nhiều nội dung khác
+- [YouTube](https://youtube.com/@BMadCode) - Video hướng dẫn, khóa học nâng cao và nhiều nội dung khác
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README_VN.md` at line 85, Replace the English phrase "master class" in the
README line that contains "[YouTube](https://youtube.com/@BMadCode) - Video
hướng dẫn, master class và nhiều nội dung khác" with a Vietnamese equivalent
(e.g., "lớp học chuyên sâu" or "khóa học nâng cao") so the line reads e.g.
"[YouTube](https://youtube.com/@BMadCode) - Video hướng dẫn, lớp học chuyên sâu
và nhiều nội dung khác".

93-93: Consider using an explicit mailto link for better portability.

The support section has been simplified effectively. For improved user experience across all Markdown renderers, use an explicit mailto link instead of the angle bracket format:

Suggested change
-BMad miễn phí cho tất cả mọi người và sẽ luôn như vậy. Hãy nhấn sao cho repo này, [mời tôi một ly cà phê](https://buymeacoffee.com/bmad), hoặc gửi email tới <contact@bmadcode.com> nếu bạn muốn tài trợ doanh nghiệp.
+BMad miễn phí cho tất cả mọi người và sẽ luôn như vậy. Hãy nhấn sao cho repo này, [mời tôi một ly cà phê](https://buymeacoffee.com/bmad), hoặc [gửi email tới contact@bmadcode.com](mailto:contact@bmadcode.com) nếu bạn muốn tài trợ doanh nghiệp.

The Buy Me a Coffee URL is valid and accessible.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README_VN.md` at line 93, Replace the bare email angle-bracket syntax
"<contact@bmadcode.com>" with an explicit mailto hyperlink so Markdown renderers
generate a clickable link; edit the README_VN.md support sentence that contains
"BMad miễn phí..." and change the angle-bracket email to
"mailto:contact@bmadcode.com" (e.g.,
[contact@bmadcode.com](mailto:contact@bmadcode.com)) to ensure consistent
portability across renderers.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README_VN.md`:
- Line 85: Replace the English phrase "master class" in the README line that
contains "[YouTube](https://youtube.com/@BMadCode) - Video hướng dẫn, master
class và nhiều nội dung khác" with a Vietnamese equivalent (e.g., "lớp học
chuyên sâu" or "khóa học nâng cao") so the line reads e.g.
"[YouTube](https://youtube.com/@BMadCode) - Video hướng dẫn, lớp học chuyên sâu
và nhiều nội dung khác".
- Line 93: Replace the bare email angle-bracket syntax "<contact@bmadcode.com>"
with an explicit mailto hyperlink so Markdown renderers generate a clickable
link; edit the README_VN.md support sentence that contains "BMad miễn phí..."
and change the angle-bracket email to "mailto:contact@bmadcode.com" (e.g.,
[contact@bmadcode.com](mailto:contact@bmadcode.com)) to ensure consistent
portability across renderers.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ea5a86e5-0b4b-41d7-8f34-172b3a620d00

📥 Commits

Reviewing files that changed from the base of the PR and between 4799153 and e7b9410.

📒 Files selected for processing (12)
  • README_VN.md
  • docs/vi-vn/explanation/analysis-phase.md
  • docs/vi-vn/explanation/party-mode.md
  • docs/vi-vn/explanation/project-context.md
  • docs/vi-vn/explanation/quick-dev.md
  • docs/vi-vn/how-to/get-answers-about-bmad.md
  • docs/vi-vn/how-to/project-context.md
  • docs/vi-vn/how-to/quick-fixes.md
  • docs/vi-vn/reference/agents.md
  • docs/vi-vn/reference/commands.md
  • docs/vi-vn/reference/core-tools.md
  • docs/vi-vn/reference/workflow-map.md

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.

1 participant