Skip to content

fix(docs): correct translation fidelity issues in Vietnamese docs#2192

Merged
alexeyv merged 1 commit intomainfrom
fix/vi-vn-review
Apr 3, 2026
Merged

fix(docs): correct translation fidelity issues in Vietnamese docs#2192
alexeyv merged 1 commit intomainfrom
fix/vi-vn-review

Conversation

@alexeyv
Copy link
Copy Markdown
Collaborator

@alexeyv alexeyv commented Apr 3, 2026

Summary

Fixes translation fidelity issues found during editorial review of #2110.

  • Stale agent architecture: Updated all references from the old separate SM/QA/Quick Flow agents to the consolidated Developer agent (bmad-agent-dev) — affects agents.md, commands.md, testing.md, getting-started.md
  • Broken link: Fixed platform-codes.yaml URL in non-interactive-installation.md (was 404)
  • Missing section: Added "Validation Commands" section to style guide
  • Content drift: Removed unsourced additions in project-context.md, fixed QA workflow framing in testing.md, corrected roadmap heading, fixed accountability softening in party-mode dialogue
  • Minor fixes: Malformed table row in style guide, roadmap link format in index.md

Test plan

  • npm run quality passes (format, lint, markdown lint, docs build, install tests, ref validation, skill validation)

Context

Full translation fidelity review report was produced comparing all 30 translated files against English sources. Zero injections found; all fixes address drift, omissions, and link issues.

Sync Vietnamese translations with current English source:
- Update agent table to consolidated Developer agent architecture
- Fix bmad-dev -> bmad-agent-dev skill ID references
- Replace Quinn/QA agent framing with built-in QA workflow
- Fix SM agent -> Developer agent in getting-started
- Fix broken platform-codes.yaml URL
- Add missing Validation Commands section to style guide
- Fix malformed table row in style guide
- Remove unsourced content additions in project-context
- Fix roadmap section heading and index link format
- Fix accountability softening in party-mode dialogue
@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Apr 3, 2026

🤖 Augment PR Summary

Summary: This PR expands and corrects the Vietnamese (vi-vn) docs to better match the current BMad Method/BMM v6 behavior.

Changes:

  • Adds a Vietnamese root README (README_VN.md) and a complete Vietnamese documentation tree under docs/vi-vn/
  • Introduces a Vietnamese doc style guide, plus new Tutorial / How-To / Explanation / Reference pages
  • Updates translated content to reflect the consolidated Developer agent (bmad-agent-dev) and current workflow framing
  • Fixes a previously broken GitHub link for platform-codes.yaml in the non-interactive installation docs
  • Adds “Validation Commands” guidance for doc authors and cleans up translation drift/unsourced additions

Technical Notes: Most changes are documentation-only; correctness hinges on links, skill IDs, and menu triggers matching the actual installed skills.

🤖 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. 3 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

order: 5
---

BMad cung cấp hai hướng kiểm thử: workflow QA tích hợp sẵn để tạo test nhanh và module Test Architect có thể cài thêm cho chiến lược kiểm thử c��p doanh nghiệp.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

docs/vi-vn/reference/testing.md:8 contains mojibake (e.g., c��p, tích h��p, S���n), which will render incorrectly in the published docs and likely indicates an encoding/copy issue. It’d be good to ensure these Vietnamese strings are valid UTF-8 and display correctly everywhere they appear.

Severity: medium

Other Locations
  • docs/vi-vn/reference/testing.md:21
  • docs/vi-vn/reference/testing.md:57

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.


| Agent | Skill ID | Trigger | Workflow chính |
| --------------------------- | -------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------- |
| Analyst (Mary) | `bmad-analyst` | `BP`, `RS`, `CB`, `WB`, `DP` | Brainstorm Project, Research, Create Brief, PRFAQ Challenge, Document Project |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

docs/vi-vn/reference/agents.md:20 lists several agent skill IDs / triggers (e.g., bmad-analyst, bmad-pm, RS, bmad-tech-writer, US) that don’t match the actual installed agent skill names/menu codes (which are bmad-agent-* in this repo). As written, readers following this page will try invoking skills/triggers that don’t exist.

Severity: medium

Other Locations
  • docs/vi-vn/reference/agents.md:14
  • docs/vi-vn/reference/agents.md:21
  • docs/vi-vn/reference/agents.md:22
  • docs/vi-vn/reference/agents.md:24
  • docs/vi-vn/reference/agents.md:25

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

| Ví dụ skill | Agent | Vai trò |
| --- | --- | --- |
| `bmad-agent-dev` | Amelia (Developer) | Triển khai story với mức tuân thủ đặc tả nghiêm ngặt |
| `bmad-pm` | John (Product Manager) | Tạo và kiểm tra PRD |
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

docs/vi-vn/reference/commands.md:83 uses bmad-pm / bmad-architect as agent skill examples, but the actual agent skills in this repo are bmad-agent-pm / bmad-agent-architect (and similarly for other roles). This mismatch can make the Vietnamese docs feel “broken” because the example invocations won’t resolve in an IDE.

Severity: medium

Other Locations
  • docs/vi-vn/reference/commands.md:84

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@alexeyv alexeyv force-pushed the fix/vi-vn-review branch from 843e7a2 to 11a362a Compare April 3, 2026 03:45
@alexeyv alexeyv merged commit 0edcd05 into main Apr 3, 2026
5 checks passed
@alexeyv alexeyv deleted the fix/vi-vn-review branch April 3, 2026 03:46
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 3, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR adds comprehensive Vietnamese localization for the BMad Method documentation suite, including a new README, documentation style guide, and 25+ reference pages covering installation, workflows, tutorials, explanations, and reference material across all major documentation categories.

Changes

Cohort / File(s) Summary
Vietnamese README
README_VN.md
Top-level Vietnamese README documenting BMad Method with feature descriptions, installation instructions, module listings, and community links.
Documentation Style Guide
docs/vi-vn/_STYLE_GUIDE.md
Comprehensive Vietnamese style guide defining Markdown formatting rules, Starlight admonition syntax, content structure templates for Tutorials/How-Tos/Explanations/References, and validation commands.
Explanation Pages
docs/vi-vn/explanation/advanced-elicitation.md, adversarial-review.md, analysis-phase.md, brainstorming.md, established-projects-faq.md, party-mode.md, preventing-agent-conflicts.md, project-context.md, quick-dev.md, why-solutioning-matters.md
Ten Vietnamese explanation pages covering BMad Method concepts including advanced elicitation techniques, adversarial review, workflow phases, Party Mode, agent conflict prevention, and design rationale.
How-To Guide Pages
docs/vi-vn/how-to/customize-bmad.md, established-projects.md, get-answers-about-bmad.md, install-bmad.md, non-interactive-installation.md, project-context.md, quick-fixes.md, shard-large-documents.md, upgrade-to-v6.md
Nine Vietnamese procedural guides covering installation, customization, project context creation, applying BMad to existing codebases, and version upgrades.
Reference Pages
docs/vi-vn/reference/agents.md, commands.md, core-tools.md, modules.md, testing.md, workflow-map.md
Six Vietnamese reference pages documenting available agents, skills/commands, built-in tools, optional modules, testing approaches, and the complete workflow map.
Navigation & Tutorials
docs/vi-vn/index.md, 404.md, roadmap.mdx, tutorials/getting-started.md
Four Vietnamese navigation pages including main documentation index, 404 error page, roadmap, and getting-started tutorial with step-by-step workflow instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 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 describes the main change—fixing translation fidelity issues in Vietnamese documentation files—and is clear and specific enough for reviewers scanning history.
Description check ✅ Passed The description clearly relates to the changeset, providing specific details about the translation fidelity fixes, affected files, and test coverage.
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
  • Commit unit tests in branch fix/vi-vn-review
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch fix/vi-vn-review

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.

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