Skip to content

docs(ko-kr): add Korean localization#2386

Open
yeomin4242 wants to merge 10 commits into
bmad-code-org:mainfrom
yeomin4242:docs/ko-kr-translation
Open

docs(ko-kr): add Korean localization#2386
yeomin4242 wants to merge 10 commits into
bmad-code-org:mainfrom
yeomin4242:docs/ko-kr-translation

Conversation

@yeomin4242

Copy link
Copy Markdown

What

Add Korean localization for the BMAD Method documentation and website UI.

This adds the full Korean docs tree under docs/ko-kr, a Korean README, Korean locale registration, and localized navigation, banner, and Starlight UI strings.

Why

The repository already supports localized documentation for multiple languages, and this change adds Korean coverage for the BMAD docs set.

The translation was reviewed against the English documentation as the source of truth to improve accuracy, readability, terminology consistency, and maintainability for future updates.

How

  • Added Korean docs under docs/ko-kr and README_KR.md.
  • Added Korean locale/i18n support in website config and Starlight strings.
  • Localized Korean navigation and moved shared banner text into locale-specific copy.
  • Reworked awkward transliterations into more natural technical Korean.

Testing

Ran:

  • npm ci
  • npm run quality

Both passed.

Notes:

  • npm ci reported existing audit findings: 4 vulnerabilities, 3 moderate and 1 high.
  • validate:skills reported medium/low findings only; strict mode passed.

@coderabbitai

coderabbitai Bot commented May 16, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This pull request adds comprehensive Korean-language documentation for the BMad Method project, providing a complete translation of the English documentation structure across 54 files including project README, style guide, conceptual explanations, how-to guides, reference materials, tutorial, and public roadmap.

Changes

Korean Documentation Translation

Layer / File(s) Summary
Landing pages and site structure
README_KR.md, docs/ko-kr/index.md, docs/ko-kr/404.md
Korean project README with badges and overview, home page with feature highlights and navigation, and error page template.
Documentation style guide
docs/ko-kr/_STYLE_GUIDE.md
Comprehensive Korean writing rules, standard document templates (tutorials, guides, explanations, references, glossaries, FAQs), checklists per document type, and validation commands for link fixing and doc builds.
Conceptual explanation pages
docs/ko-kr/explanation/* (11 pages)
Korean explanations of BMad Method concepts: advanced elicitation, adversarial review, analysis phase, brainstorming, checkpoint preview workflow, established projects FAQ, forensic investigation, named agents, party mode, preventing agent conflicts, project context, quick development workflow, and why solutioning matters.
Practical how-to guides
docs/ko-kr/how-to/* (13 pages)
Korean step-by-step guides covering BMad installation and updates, customization and organizational expansion, project setup for established codebases, custom module installation, project context creation, quick fixes, document sharding, v6 migration, and finding help.
Reference documentation
docs/ko-kr/reference/* (5 pages)
Korean reference pages documenting named agents and their triggers, commands/skills, core tools with usage details, official modules, testing options (built-in QA and TEA module), and complete workflow map with stage breakdowns.
Getting-started tutorial and roadmap
docs/ko-kr/tutorials/getting-started.md, docs/ko-kr/roadmap.mdx
Korean first-time user tutorial guiding installation through first project completion, and public roadmap documenting in-progress, planned, and community-driven initiatives.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • bmad-code-org/BMAD-METHOD#2183: Adds English documentation for checkpoint-preview workflow that is also localized in this Korean PR.
  • bmad-code-org/BMAD-METHOD#2355: Adds Korean and Chinese localization for named-agents.md and expand-bmad-for-your-org.md, overlapping content translations.
  • bmad-code-org/BMAD-METHOD#2094: Updates installation documentation including non-interactive/CI installation details that are reflected in this Korean localization.

Suggested reviewers

  • alexeyv
  • bmadcode
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding Korean localization to documentation and website UI, which matches the changeset content.
Description check ✅ Passed The description is directly related to the changeset, explaining what was added (Korean docs, README, locale support), why it matters, and how it was implemented.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/ko-kr/roadmap.mdx

Oops! Something went wrong! :(

ESLint: 9.39.4

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/ko-kr/reference/agents.md`:
- Line 14: The example developer skill ID in docs/ko-kr/reference/agents.md
currently uses `bmad-dev`, which conflicts with other PR docs that reference
`bmad-agent-dev`; update the example in that file to use the consistent real
skill ID `bmad-agent-dev` so users won't be given an incorrect ID (search for
the string `bmad-dev` in the file and replace it with `bmad-agent-dev`).

In `@docs/ko-kr/roadmap.mdx`:
- Line 88: Update the outdated sentence "AI 네이티브 개발에 관한 대화입니다. 2026년 3월 1일 공개
예정입니다." in the roadmap content: either remove the future-date phrase and state
it as already published (e.g., "공개됨" / "2026년 3월 1일 공개") or replace with a
date-agnostic phrase like "곧 공개 예정" or "공개 예정" as appropriate; ensure the
updated sentence preserves the original intent about the AI 네이티브 개발 대화 and
adjust surrounding wording for tense consistency.

In `@docs/ko-kr/tutorials/getting-started.md`:
- Around line 119-120: The tutorial uses inconsistent agent skill IDs (e.g.,
bmad-agent-pm, bmad-agent-architect, bmad-agent-analyst, bmad-agent-ux-designer)
that don't match the reference IDs (bmad-pm, bmad-architect, bmad-analyst,
bmad-ux-designer); update every occurrence in the getting-started.md text
(including the shown block and the other noted lines around 163, 170-171,
180-181, 186-187, 259) to use the canonical IDs (bmad-pm, bmad-architect,
bmad-analyst, bmad-ux-designer) so commands/examples will run correctly and
consistently with the reference doc.
🪄 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: 86abd0e9-1abb-4c09-af2d-afd2c739723a

📥 Commits

Reviewing files that changed from the base of the PR and between 5090cfb and 514f15e.

⛔ Files ignored due to path filters (4)
  • website/astro.config.mjs is excluded by !website/**
  • website/src/components/Banner.astro is excluded by !website/**
  • website/src/content/i18n/ko-KR.json is excluded by !website/**
  • website/src/lib/locales.mjs is excluded by !website/**
📒 Files selected for processing (36)
  • README_KR.md
  • docs/ko-kr/404.md
  • docs/ko-kr/_STYLE_GUIDE.md
  • docs/ko-kr/explanation/advanced-elicitation.md
  • docs/ko-kr/explanation/adversarial-review.md
  • docs/ko-kr/explanation/analysis-phase.md
  • docs/ko-kr/explanation/brainstorming.md
  • docs/ko-kr/explanation/checkpoint-preview.md
  • docs/ko-kr/explanation/established-projects-faq.md
  • docs/ko-kr/explanation/forensic-investigation.md
  • docs/ko-kr/explanation/named-agents.md
  • docs/ko-kr/explanation/party-mode.md
  • docs/ko-kr/explanation/preventing-agent-conflicts.md
  • docs/ko-kr/explanation/project-context.md
  • docs/ko-kr/explanation/quick-dev.md
  • docs/ko-kr/explanation/why-solutioning-matters.md
  • docs/ko-kr/how-to/customize-bmad.md
  • docs/ko-kr/how-to/established-projects.md
  • docs/ko-kr/how-to/expand-bmad-for-your-org.md
  • docs/ko-kr/how-to/get-answers-about-bmad.md
  • docs/ko-kr/how-to/install-bmad.md
  • docs/ko-kr/how-to/install-custom-modules.md
  • docs/ko-kr/how-to/non-interactive-installation.md
  • docs/ko-kr/how-to/project-context.md
  • docs/ko-kr/how-to/quick-fixes.md
  • docs/ko-kr/how-to/shard-large-documents.md
  • docs/ko-kr/how-to/upgrade-to-v6.md
  • docs/ko-kr/index.md
  • docs/ko-kr/reference/agents.md
  • docs/ko-kr/reference/commands.md
  • docs/ko-kr/reference/core-tools.md
  • docs/ko-kr/reference/modules.md
  • docs/ko-kr/reference/testing.md
  • docs/ko-kr/reference/workflow-map.md
  • docs/ko-kr/roadmap.mdx
  • docs/ko-kr/tutorials/getting-started.md

Comment thread docs/ko-kr/reference/agents.md Outdated
Comment thread docs/ko-kr/roadmap.mdx Outdated
Comment thread docs/ko-kr/tutorials/getting-started.md
@yeomin4242

Copy link
Copy Markdown
Author

Hi, @alexeyv @bmadcode

I’ve completed the Korean translation. could you review it?

And then As I mentioned on Discord, some of the example commands aren’t up to date. I asked if it would be possible to submit a PR for the remaining languages after I finish updating them. Would that be okay?

@eatse21

eatse21 commented May 22, 2026

Copy link
Copy Markdown
Contributor

Hi @yeomin4242! French translator here,

Thanks for your participation for translation contribution! I think the team is more active on the weekend for merging pull requests.

Few things that came to me reviewing your commits:

  • Nice catch for translating Banner.astro strings, the french part looks good to me
  • You may consider translating the website/public/workflow-map-diagram.html file that appears on /reference/workflow-map/. For now I'm the only one translator having done this part so not sure if others should do it as well? We may need a solution to separate style/markup from translations, I'm not very pleased by having duplicated the current file for french.
  • The sidebar order numbering (from YAML frontmatter) has the same problems as the current english one, I made a tool to find those easily in the future (feat(docs): Add sidebar order validator for doc frontmatter #2409). This is what it outputs for korean:
Validating sidebar ordering in: /home/user/bmad/docs

English sections: explanation, how-to, reference, tutorials
Translation languages: cs, fr, ko-kr, vi-vn, zh-cn

[...English and others...]

Checking ko-kr/ docs
  ko-kr/explanation/
    [ERROR] Duplicate order 6: ko-kr/explanation/advanced-elicitation.md
    [ERROR] Duplicate order 6: ko-kr/explanation/forensic-investigation.md
    [ERROR] Duplicate order 1: ko-kr/explanation/analysis-phase.md
    [ERROR] Duplicate order 1: ko-kr/explanation/named-agents.md
    [ERROR] Duplicate order 2: ko-kr/explanation/brainstorming.md
    [ERROR] Duplicate order 2: ko-kr/explanation/quick-dev.md
    [ERROR] Duplicate order 3: ko-kr/explanation/checkpoint-preview.md
    [ERROR] Duplicate order 3: ko-kr/explanation/why-solutioning-matters.md
    [ERROR] Duplicate order 7: ko-kr/explanation/party-mode.md
    [ERROR] Duplicate order 7: ko-kr/explanation/project-context.md
  ko-kr/how-to/
    [ERROR] Duplicate order 9: ko-kr/how-to/expand-bmad-for-your-org.md
    [ERROR] Duplicate order 9: ko-kr/how-to/project-context.md
  ko-kr/reference/
    [ERROR] Duplicate order 2: ko-kr/reference/agents.md
    [ERROR] Duplicate order 2: ko-kr/reference/core-tools.md
  ko-kr/tutorials/
    [OK] ko-kr/tutorials/ — all orders valid

With this on-going effort, we may eventually get this be consistent across all doc languages, for now we have to adjust a bit manually. I’ve corrected the numbering in my current PR if you want to look at it.

@yeomin4242

Copy link
Copy Markdown
Author

@eatse21

Thanks for pointing this out!

I also updated the Korean workflow map for this PR by adding website/public/workflow-map-diagram-ko-kr.html and linking it from docs/ko-kr/reference/workflow-map.md.

I agree that duplicating the whole HTML file is probably not the best long-term solution. Separating the text from the markup/styles would be better.

For now, I followed the current localized-file approach so the Korean docs can have the translated diagram as well.

I’ll also fix the Korean docs issues such as the sidebar order conflicts.

Thanks!

@bmadcode

Copy link
Copy Markdown
Collaborator

@yeomin4242 @eatse21 thanks for the contribution and comments. before merging - @yeomin4242 will you be available to every once in a while make updates as other changes come? Theres are some significant changes coming soon that will result in some major doc updates

@yeomin4242

yeomin4242 commented May 25, 2026

Copy link
Copy Markdown
Author

@yeomin4242 @eatse21 thanks for the contribution and comments. before merging - @yeomin4242 will you be available to every once in a while make updates as other changes come? Theres are some significant changes coming soon that will result in some major doc updates

@bmadcode

Thanks for the heads-up. Yes, I’d be happy to help keep the updated as the docs change.

Feel free to tag me on relevant issues or PRs, and I’ll do my best to review and update them.

@eatse21

eatse21 commented May 25, 2026

Copy link
Copy Markdown
Contributor

@yeomin4242 a simple trick I use to keep track changes, is tracking the docs and website folders new commits inside your favorite feed/rss reader by entering those urls

So then you can have a quick glance on only the relevant commits of the repo, and see if some english source doc changed

@alexeyv alexeyv force-pushed the docs/ko-kr-translation branch from 2e930e6 to 3e20859 Compare June 11, 2026 09:47
@yeomin4242

Copy link
Copy Markdown
Author

From the recent Korean localization sync commits (47cf70f0, c8784a16, 41045984, and 77628f00), the latest changes adapted the fixes discussed in #2408 and #2439 for the Korean translation after verifying them against the current docs and installer behavior:

File Line(s) Issue Status
reference/agents.md 14, 20-25 Outdated default agent skill IDs should use canonical bmad-agent-* names. Confirmed - Fixed in c8784a16
reference/agents.md 15, 21, 35 Outdated PM trigger examples: PRD actions are now consolidated under PRD. Confirmed - Fixed in c8784a16
reference/agents.md 23 Developer trigger list should include IN for forensic investigation. Already fixed upstream in #2410; synced in c8784a16
reference/agents.md 25, 43-46 Technical Writer docs should no longer mention US, since the current menu no longer defines it. Confirmed - Fixed in c8784a16
reference/agents.md 21 Correct Course was translated as 경로 수정, which can read like filesystem path correction in Korean. Confirmed - Polished in 77628f00
reference/commands.md 44-46 Outdated Cursor/Windsurf skill paths: .cursor/skills, .windsurf/skills. Confirmed - Fixed in c8784a16
reference/commands.md 82-84 Example agent skill IDs were outdated: bmad-pm, bmad-architect. Confirmed - Fixed in c8784a16
reference/commands.md 96-98 Workflow examples should include the current UX workflow bmad-ux. Confirmed - Fixed in c8784a16
reference/commands.md 124 “Core module includes 11 built-in tools” was outdated. Confirmed - Fixed to 12 tools in c8784a16
reference/core-tools.md 16-29, 300-321 Core tools overview was missing bmad-customize and its detailed reference section/link. Confirmed - Fixed in c8784a16
reference/workflow-map.md 16, 19 Korean workflow map should use the localized diagram asset. Confirmed - Fixed in c8784a16
reference/workflow-map.md 40 The phrase spine 쌍 was too literal and sounded like translationese in Korean. Confirmed - Polished in 77628f00
explanation/party-mode.md 12 “BMad Master orchestrates” was leftover from the old model; there is no BMad Master agent in the repo. Confirmed - Fixed and polished in 77628f00
_STYLE_GUIDE.md 68 Style guide example still used bmad-create-prd, while current user-facing docs consistently use bmad-prd. Confirmed - Fixed in 77628f00
how-to/customize-bmad.md 72 Cursor skill path still referenced .cursor/skills/, but the current installer config and commands docs use .agents/skills/. Confirmed - Fixed in 77628f00
explanation/web-bundles.md, how-to/use-web-bundles.md multiple Web bundle documentation needed Korean localization and wording polish after the upstream additions. Confirmed - Synced in c8784a16, polished in 41045984
roadmap.mdx multiple Stale roadmap date/text needed to be aligned with the current docs. Confirmed - Fixed in c8784a16
tutorials/getting-started.md multiple Getting Started examples needed updated skill IDs, bmad-prd, bmad-ux, and current workflow references. Confirmed - Fixed in c8784a16

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