Skip to content

docs: refine English and Korean docs for clarity and consistency - #10

Merged
seokju-na merged 1 commit into
mainfrom
docs/refine-docs-en-ko
Jul 2, 2026
Merged

docs: refine English and Korean docs for clarity and consistency#10
seokju-na merged 1 commit into
mainfrom
docs/refine-docs-en-ko

Conversation

@seokju-na

@seokju-na seokju-na commented Jul 2, 2026

Copy link
Copy Markdown
Member

Summary

A "polish once more" pass over the documentation content (English + Korean), continuing the i18n work from #8. I distilled a shared style guide from three references — Vite's concise, active voice; the technical-writing.dev review principles; and Toss's Korean 존댓말 conventions — and applied it across all 57 topic pairs via a multi-agent workflow, with every change adversarially verified against its own diff.

Changes

Korean (41 files)

  • Fixed 19 josa errors번들 ends in ㄹ, so it takes 은/을/이, but Webview Bundle는 / Bundle를 were incorrect.
  • Unified terminology첫 페인트첫 화면, 미리보기미리 보기, 내려받다다운로드, and the builtin source 내장빌트인 (generic "built-in signing / SHA check" stays 내장).
  • Removed translationese (번역투) and unnecessary passive constructions.

English (7 files)

  • Passive→active voice, split run-on sentences, tightened wording; grammatical over-the-air (adjective) vs over the air (adverb).

Guardrails

  • No code, commands, API signatures, config keys, URLs, versions, or frontmatter titles changed.
  • English and Korean kept in structural lockstep; net diff is 89/89 balanced (in-place edits only, no lines added or removed).

Validation

  • yarn gen:fumadocs — all MDX parses
  • yarn build — full production build passes (all pages incl. Korean variants compile)

🤖 Generated with Claude Code


Summary by cubic

Polished the English and Korean docs for clarity and consistency. Standardized terminology, tightened phrasing, and aligned pages across commands and platforms with no behavior changes.

  • Refactors
    • Korean: fixed 19 josa errors; unified terms (첫 화면, 미리 보기, 다운로드, and 빌트인 for the builtin source); trimmed passives and translationese; corrected one title josa (“Webview Bundle를”→“Webview Bundle을”).
    • English: moved to active voice and shorter sentences; corrected “over-the-air” (adj.) vs “over the air” (adv.); clearer command phrasing (e.g., “omit it”).
    • Cross-pages: aligned wording across command pages (wvb download, wvb pack, wvb builtin/deploy) and platform docs (Electron Builder/Forge, Tauri, Android, Deno, iOS); consistent “built‑in fallback” in KO.
    • Guardrails: no code, commands, API signatures, config keys, or URLs changed; EN/KO kept in structural lockstep; MDX generation and production build pass.

Written for commit 6d01f8d. Summary will update on new commits.

Review in cubic

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 2, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
webview-bundle-website 6d01f8d Commit Preview URL

Branch Preview URL
Jul 02 2026, 08:01 AM

@cubic-dev-ai cubic-dev-ai 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.

1 issue found across 48 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="content/docs/references/node/updater.ko.mdx">

<violation number="1" location="content/docs/references/node/updater.ko.mdx:6">
P3: `예를 들어 다음 앱 재시작 시점입니다`가 불완전한 문장입니다. 원문 영문(`for example on the next app restart`)은 전치사구로 종결되어도 문제없지만, 한국어에서 `~시점입니다`로 끝나면 서술어가 빠져 어색합니다. 원래 `시점에 전환하면 됩니다`가 자연스러운 한국어 문장이었습니다. `시점에 전환할 수 있습니다` 또는 `시점입니다. 이때 전환하면 됩니다` 식으로 서술어를 살려주세요.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

---

`Updater`는 번들의 무선(OTA) 업데이트를 처리합니다. [`BundleSource`](/docs/references/node/source)와 [`Remote`](/docs/references/node/remote)를 짝지어 동작합니다. 원격 서버에서 더 새로운 버전을 확인하고, 소스의 원격 디렉터리로 다운로드한 뒤 활성화합니다. 확인, 다운로드, 활성화 단계는 각각 별도의 메서드입니다. 따라서 백그라운드에서 업데이트를 스테이징해 두고 나중에 전환할 수 있습니다. 예를 들어 다음 앱 재시작 시점에 전환하면 됩니다. 전체 흐름은 [원격 번들](/docs/guide/remote-bundles)을 참고하세요.
`Updater`는 번들의 무선(OTA) 업데이트를 처리합니다. [`BundleSource`](/docs/references/node/source)와 [`Remote`](/docs/references/node/remote)를 짝지어 동작합니다. 원격 서버에서 더 새로운 버전을 확인하고, 소스의 원격 디렉터리로 다운로드한 뒤 활성화합니다. 확인, 다운로드, 활성화 단계는 각각 별도의 메서드입니다. 따라서 백그라운드에서 업데이트를 스테이징해 두고 나중에 전환할 수 있습니다. 예를 들어 다음 앱 재시작 시점입니다. 전체 흐름은 [원격 번들](/docs/guide/remote-bundles)을 참고하세요.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P3: 예를 들어 다음 앱 재시작 시점입니다가 불완전한 문장입니다. 원문 영문(for example on the next app restart)은 전치사구로 종결되어도 문제없지만, 한국어에서 ~시점입니다로 끝나면 서술어가 빠져 어색합니다. 원래 시점에 전환하면 됩니다가 자연스러운 한국어 문장이었습니다. 시점에 전환할 수 있습니다 또는 시점입니다. 이때 전환하면 됩니다 식으로 서술어를 살려주세요.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At content/docs/references/node/updater.ko.mdx, line 6:

<comment>`예를 들어 다음 앱 재시작 시점입니다`가 불완전한 문장입니다. 원문 영문(`for example on the next app restart`)은 전치사구로 종결되어도 문제없지만, 한국어에서 `~시점입니다`로 끝나면 서술어가 빠져 어색합니다. 원래 `시점에 전환하면 됩니다`가 자연스러운 한국어 문장이었습니다. `시점에 전환할 수 있습니다` 또는 `시점입니다. 이때 전환하면 됩니다` 식으로 서술어를 살려주세요.</comment>

<file context>
@@ -3,7 +3,7 @@ title: Updater
 ---
 
-`Updater`는 번들의 무선(OTA) 업데이트를 처리합니다. [`BundleSource`](/docs/references/node/source)와 [`Remote`](/docs/references/node/remote)를 짝지어 동작합니다. 원격 서버에서 더 새로운 버전을 확인하고, 소스의 원격 디렉터리로 다운로드한 뒤 활성화합니다. 확인, 다운로드, 활성화 단계는 각각 별도의 메서드입니다. 따라서 백그라운드에서 업데이트를 스테이징해 두고 나중에 전환할 수 있습니다. 예를 들어 다음 앱 재시작 시점에 전환하면 됩니다. 전체 흐름은 [원격 번들](/docs/guide/remote-bundles)을 참고하세요.
+`Updater`는 번들의 무선(OTA) 업데이트를 처리합니다. [`BundleSource`](/docs/references/node/source)와 [`Remote`](/docs/references/node/remote)를 짝지어 동작합니다. 원격 서버에서 더 새로운 버전을 확인하고, 소스의 원격 디렉터리로 다운로드한 뒤 활성화합니다. 확인, 다운로드, 활성화 단계는 각각 별도의 메서드입니다. 따라서 백그라운드에서 업데이트를 스테이징해 두고 나중에 전환할 수 있습니다. 예를 들어 다음 앱 재시작 시점입니다. 전체 흐름은 [원격 번들](/docs/guide/remote-bundles)을 참고하세요.
 
 ```ts
</file context>
Suggested change
`Updater`는 번들의 무선(OTA) 업데이트를 처리합니다. [`BundleSource`](/docs/references/node/source)[`Remote`](/docs/references/node/remote)를 짝지어 동작합니다. 원격 서버에서 더 새로운 버전을 확인하고, 소스의 원격 디렉터리로 다운로드한 뒤 활성화합니다. 확인, 다운로드, 활성화 단계는 각각 별도의 메서드입니다. 따라서 백그라운드에서 업데이트를 스테이징해 두고 나중에 전환할 수 있습니다. 예를 들어 다음 앱 재시작 시점입니다. 전체 흐름은 [원격 번들](/docs/guide/remote-bundles)을 참고하세요.
`Updater`는 번들의 무선(OTA) 업데이트를 처리합니다. [`BundleSource`](/docs/references/node/source)[`Remote`](/docs/references/node/remote)를 짝지어 동작합니다. 원격 서버에서 더 새로운 버전을 확인하고, 소스의 원격 디렉터리로 다운로드한 뒤 활성화합니다. 확인, 다운로드, 활성화 단계는 각각 별도의 메서드입니다. 따라서 백그라운드에서 업데이트를 스테이징해 두고 나중에 전환할 수 있습니다. 예를 들어 다음 앱 재시작 시점에 전환하면 됩니다. 전체 흐름은 [원격 번들](/docs/guide/remote-bundles)을 참고하세요.

A polish pass over all 57 documentation pairs (English + Korean),
applying a shared style guide distilled from three references: Vite's
concise, active voice; the technical-writing.dev review principles; and
Toss's Korean 존댓말 conventions.

Korean (41 files):
- Fix 19 josa errors — "번들" ends in ㄹ so it takes 은/을/이, but
  "Webview Bundle는" / "Bundle를" were incorrect.
- Unify terminology: 첫 페인트 → 첫 화면, 미리보기 → 미리 보기,
  내려받다 → 다운로드, and the `builtin` source 내장 → 빌트인
  (generic "built-in signing / SHA check" stays 내장).
- Remove translationese and unnecessary passive constructions.

English (7 files):
- Passive → active voice, split run-on sentences, tighten wording;
  grammatical "over-the-air" (adjective) vs "over the air" (adverb).

No code, commands, API signatures, config keys, URLs, versions, or
frontmatter titles were changed; EN and KO kept in structural lockstep
(net diff is 89/89 balanced, in-place edits only).

Validated with `yarn gen:fumadocs` and `yarn build`.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Gz6nnskhiMrHZvJ2dGE9qa
@seokju-na
seokju-na force-pushed the docs/refine-docs-en-ko branch from a95bad4 to 6d01f8d Compare July 2, 2026 07:59
@seokju-na
seokju-na merged commit 5d0f658 into main Jul 2, 2026
3 checks passed
@seokju-na
seokju-na deleted the docs/refine-docs-en-ko branch July 2, 2026 14:48
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