Skip to content

docs: add Korean translation of README (README.ko.md) - #4396

Open
comeddy wants to merge 1 commit into
awslabs:mainfrom
comeddy:docs/korean-readme
Open

docs: add Korean translation of README (README.ko.md)#4396
comeddy wants to merge 1 commit into
awslabs:mainfrom
comeddy:docs/korean-readme

Conversation

@comeddy

@comeddy comeddy commented Aug 4, 2026

Copy link
Copy Markdown

Fixes N/A

Summary

Changes

Adds README.ko.md, a complete Korean translation of the root README.md, as a separate file. README.md itself is left untouched.

  • Translates all 74 headings, all 101 server-table descriptions, and the prose sections (transport mechanisms, SSE removal notice, local vs remote servers, use cases, installation and setup, running in containers, and the per-client guides for Kiro, Cline, Cursor, Windsurf, VS Code and Claude Code)
  • Regenerates the table of contents with GitHub-compatible anchors for the Korean headings. This also picks up two entries that are missing from the English TOC today: Migration & Modernization and Open Data
  • Adds a short note at the top pointing back to README.md as the source of truth

Deliberately kept in English:

  • The 16 external article/video titles under "Additional Resources", so the link text still matches the English page it points to
  • Protocol and product names such as streamable HTTP
  • The paste-ready Custom Instructions snippet in the Cline section, since translating it would change what the agent actually receives

User experience

Before: the README is only available in English.

After: Korean readers can open README.ko.md for the same content. README.md is byte-for-byte unchanged, so there is no impact on existing readers and no merge conflict surface for in-flight PRs that touch the English README.

Everything that is not prose was verified to be preserved exactly:

Check Result
Install badge cells (101) byte-identical to README.md
URLs (642) byte-identical
<img> tags (9) byte-identical
Relative links (68) identical, all targets resolve on disk
In-page TOC anchors (74) 0 broken
Code fences (19) count unchanged; only explanatory comments translated

Checklist

If your change doesn't seem to apply, please leave them unchecked.

  • I have reviewed the contributing guidelines
  • I have performed a self-review of this change
  • Changes have been tested
  • Changes are documented

Is this a breaking change? (Y/N) N

RFC issue number: N/A

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.


Note for maintainers

I saw that #4106 added Japanese through the Docusaurus i18n locale mechanism (docusaurus/i18n/ja/..., locales: ['en', 'ja']), and that there is currently no translated README anywhere in the repo. I went with a root-level README.ko.md because the root README is the first thing most people land on, and because it keeps the change to a single additive file.

If you would rather standardize on the Docusaurus locale approach, I am happy to rework this into a ko locale instead, or to close this in favor of an issue to discuss the direction first.

Add a full Korean translation of the root README as a separate file so the
English original stays untouched and future upstream pulls do not conflict.

- Translate all 74 headings, 101 server-table descriptions and the prose
  sections (transport, local vs remote, installation, per-client guides)
- Regenerate the table of contents with GitHub-compatible anchors, including
  the two entries missing upstream (Migration & Modernization, Open Data)
- Keep install badges, URLs, image tags and relative links byte-identical
- Leave external article titles, protocol names and the paste-ready Cline
  prompt snippet in English on purpose
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To triage

Development

Successfully merging this pull request may close these issues.

1 participant