Skip to content

docs(ko): add Korean translation for getting-started pages - #993

Merged
lizhengfeng101 merged 1 commit into
alibaba:mainfrom
amondnet:docs/ko-getting-started
Aug 26, 2026
Merged

docs(ko): add Korean translation for getting-started pages#993
lizhengfeng101 merged 1 commit into
alibaba:mainfrom
amondnet:docs/ko-getting-started

Conversation

@amondnet

@amondnet amondnet commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Description

Korean translations for the three getting-started docs pages — quickstart, installation, configuration (654 lines of English source) — following the incremental batch pattern of the Russian docs (#696/#698/#701), as follow-up to the ko UI locale (#857).

  • docsMap's ko entry graduates from {} to a partial LocalizedDocs; the 13 untranslated pages keep falling back to English per-page.
  • Terminology reuses what ko.ts already ships (프로바이더, 내장, 대화형, 워크스페이스 모드), so docs and UI never disagree.
  • Code blocks, flags, config keys, URLs, and the provider table values are verbatim; only prose and bash comments are translated.
  • DOCS_LOCALES in check-translation-sync.js intentionally still excludes ko — sync warnings would be unactionable until the full set exists. It flips in the final batch.

Remaining pages will follow in two batches: the four integration guides, then the rest + the DOCS_LOCALES flip.

Korean quickstart page rendered with Korean sidebar and TOC

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring (no functional changes)
  • Documentation update
  • CI / Build / Tooling

How Has This Been Tested?

  • make test passes locally
  • Manual testing (describe below)

typecheck / lint / test (32/32) / build / size (94.7 kB / 150 kB) and go run scripts/verify-english-only.go all pass. Rendering verified with headless Chrome under --accept-lang=ko-KR: the three pages serve Korean content with a Korean TOC, untranslated pages still fall back to English.

Checklist

  • My code follows the project's coding style (go fmt, go vet)
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the documentation accordingly (if applicable)
  • I have signed the CLA

Related Issues

Follow-up to #471 / #857.

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

🔍 OpenCodeReview found 1 issue(s) in this PR.

  • ✅ Successfully posted inline: 1 comment(s)

Comment thread pages/src/content/docs/index.ts
@amondnet
amondnet force-pushed the docs/ko-getting-started branch from 5c78b84 to 2acc230 Compare August 18, 2026 11:02
@amondnet
amondnet marked this pull request as ready for review August 18, 2026 14:56

@wu21-web wu21-web left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

index.ts looks good.

@lizhengfeng101 lizhengfeng101 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@amondnet nice work!However, the current main branch is outdated; it needs to be updated by rebasing onto the latest main before merging.

Translates quickstart, installation, and configuration — the three pages
a new Korean-speaking user hits first — following the incremental locale
pattern the Russian docs used (alibaba#696). docsMap's ko entry graduates from
{} to a partial LocalizedDocs; the remaining pages keep falling back to
English per-page.

DOCS_LOCALES in check-translation-sync.js intentionally still excludes
ko: warnings on en-docs changes would be unactionable until the full set
is translated. It flips in the final batch.

Terminology matches the ko UI locale (alibaba#857): 프로바이더, 내장, 대화형,
워크스페이스 모드, and the staged/unstaged/untracked renderings all reuse
the strings ko.ts already ships.
@amondnet
amondnet force-pushed the docs/ko-getting-started branch from 2acc230 to 0e5d68f Compare August 25, 2026 17:04
@amondnet

Copy link
Copy Markdown
Contributor Author

@lizhengfeng101 Thanks — rebased onto the latest main.

@lizhengfeng101 lizhengfeng101 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@lizhengfeng101
lizhengfeng101 merged commit 237d238 into alibaba:main Aug 26, 2026
14 checks passed
lizhengfeng101 pushed a commit that referenced this pull request Aug 27, 2026
* docs(ko): add Korean translation for integration guides

Translate the four integration guides — agent-skill, claude-code, ci,
delegate (897 lines of English source) — as the second batch of the ko
docs rollout started in #993.

Korean headings cannot produce an ASCII slug (generateHeadingId keeps
only [a-z0-9] and CJK ideographs), so every heading carries an explicit
`{#id}` marker reusing the English slug. Without it the anchors collapse
to empty or colliding ids and the TOC stops resolving. Reusing the
English slug also keeps deep links stable across a language switch.

`DOCS_LOCALES` in check-translation-sync.js still excludes `ko`; it
flips in the final batch once every page exists.

* docs(ko): polish translationese in integration guides

Fix an inverted meaning and tighten literal renderings found by a
Korean-prose pass over the four translated guides.

`CI_JOB_TOKEN` was described with "대체로", which reads as "generally"
in Korean and made the fallback sound like normal behaviour — the
English says "as a fallback". It now reads "대체 수단으로".

The rest are literal renderings that do not hold up in Korean:
"thin wrappers" as "얇게 감싼 것", "tighten" as "조이다", "brand the
reviewer" as "브랜드를 붙이다", and "JSON envelope" as "JSON 봉투"
(ja/zh render it 外殻, ru объект JSON — only the Korean was literal).
Also fixes a subject-predicate mismatch in the concurrency section and
drops two commas that mirrored English ", and".

Prose only: code blocks, flags, config keys, URLs, table values and the
explicit `{#id}` heading markers are untouched, and the ko anchor
sequence still matches en for all four files.
lizhengfeng101 pushed a commit that referenced this pull request Aug 27, 2026
Translate cli-reference, review-rules and tools (1,421 lines of English
source) as the third batch of the ko docs rollout, following #993 and
#1072.

Flag descriptions reuse the wording ko.ts already ships for the same
flags (docs.reviewFlag*/docs.scanFlag*), so the docs and the landing
page never describe a flag differently. CLI help output, JSON payloads
and tool schemas stay verbatim — only prose, table descriptions and
shell comments are translated.

Every heading carries an explicit `{#id}` reusing the English slug, as
established in #1072: Korean headings otherwise collapse to empty or
colliding anchors and the TOC stops resolving. The ko anchor sequence
is identical to en for all three files, and review-rules keeps the
`#content-sniffing-for-m-files` link working.

`DOCS_LOCALES` in check-translation-sync.js still excludes `ko`; it
flips in the final batch, which covers the remaining six pages.
lizhengfeng101 pushed a commit that referenced this pull request Aug 27, 2026
* docs(ko): complete the Korean docs locale

Final batch of the ko rollout started in #993 and continued in #1072 /
#1080. Translates the last six pages and promotes ko to a complete
locale.

New pages: architecture, mcp, viewer, telemetry, contributing, faq.
Code blocks, flags, config keys, CLI/program output, mermaid sources and
URLs stay verbatim; only prose, table text, and shell/tree comments are
translated. Terminology follows pages/src/i18n/ko.ts and the three
earlier batches (코멘트 · 라운드 · 서브 Agent · 프리셋).

koDocs is now Record<DocSlug, string> instead of a partial map, and the
per-page English-fallback comment is dropped — every slug is translated.
Entries are reordered to match the en/zh/ja key order.

DOCS_LOCALES in check-translation-sync.js now includes "ko", so a future
en docs change asks for its ko counterpart like it does for zh/ja/ru.
The test fixtures that enumerate the counterpart locales are updated to
match.

Also backfills explicit {#en-slug} heading anchors on quickstart,
installation and configuration. Those three predate the anchor
convention adopted in #1072: generateHeadingId() keeps only
[a-z0-9一-鿿], so their Korean headings collapsed to empty and
colliding ids (10 of 18 empty on installation). Deep links into them
were dead — including ../configuration/#timeouts and
../configuration/#reuse-existing-environment-variables, which the new
faq page links to.

Verified: ko heading-id sequence is identical to en on all 16 pages, no
empty ids, every in-page and cross-page fragment link resolves, no {#…}
marker leaks into rendered text. npm run typecheck / lint / test (32) /
build / size (94.68 kB of 150 kB), verify-english-only.go,
verify-license.sh, check-translation-sync tests, plus headless-Chrome
renders with --accept-lang=ko-KR on all nine touched pages.

One deliberate divergence from en: en/faq.md links to #filtering--rules
(two hyphens), which no heading generates — the ko page links to the
working #filtering-rules.

* docs(ko): space before parenthetical qualifiers in h2/h3 headings

The right-hand TOC strips `()` from heading text (extractHeadings.ts),
so `Plan(선택)` renders as `Plan선택` with the words fused. English
headings keep a space before the parenthesis and read fine after the
strip; five Korean headings did not. Adds the space, matching the
spacing already used by `NPM (권장)` and `Homebrew (macOS / Linux)`.

Explicit {#en-slug} anchors are unchanged, so no link breaks.
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