Skip to content

docs(i18n): sync zh-TW README with English parity - #5099

Merged
PerishCode merged 2 commits into
nexu-io:mainfrom
laihenyi:docs/i18n-zh-tw-readme-parity
Jul 9, 2026
Merged

docs(i18n): sync zh-TW README with English parity#5099
PerishCode merged 2 commits into
nexu-io:mainfrom
laihenyi:docs/i18n-zh-tw-readme-parity

Conversation

@laihenyi

@laihenyi laihenyi commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Why

I keep the Traditional Chinese README in parity with the English source (prior parity work: #3251). Checking docs/i18n/README.zh-TW.md against README.md again, it had drifted on several blocks, so zh-TW readers get an incomplete onboarding: no hosted curl … install.sh path, no WSL2 guidance, no macOS Docker Desktop note, and the download links lack the attribution the English ones carry.

The English source is the source of truth, so this brings zh-TW back in line with the current README.md.

What users will see

zh-TW README readers now see the same content as the English README:

  • The hosted curl -fsSL https://open-design.ai/install.sh | sh -s <agent> install option plus the install.sh wrapper explanation (from fix(landing): serve hosted install.sh wrapper #4866).
  • The WSL2 note in the "install into your coding agent" section, and the wsl-setup.md pointer in the run-from-source line.
  • The macOS users note in the Docker section (the Authorization: Bearer … required / Docker Desktop bridge-networking fix).
  • utm_source / utm_medium / utm_content attribution on the six open-design.ai links (from chore(readme): add UTM attribution to open-design.ai links #4792).

Surface area

  • None — documentation / translation update only. Single file (docs/i18n/README.zh-TW.md); no code, no i18n Dict keys, no dependencies.

Screenshots

N/A — docs-only change.

Bug fix verification

N/A — not a bug fix; this is a translation-parity sync against the English README.

Validation

  • Link parity: every https link present in README.md now also appears in README.zh-TW.md (only the auto-generated contributor-wall avatar differs, which is refreshed by bot PRs).
  • No dead links: confirmed the newly referenced targets exist — docs/wsl-setup.md, docs/windows-troubleshooting.md, and the ### Docker Desktop on macOS heading in deploy/README.md (anchor #docker-desktop-on-macos).
  • Structure preserved: heading structure is byte-identical to origin/main's zh-TW version — the change only adds a code line, two prose blocks, one blockquote, and query-string suffixes; no headings touched. Diff is +18 / -7.

Adjacent issues (not in this PR)

The WSL2 note, the macOS Docker note, and the UTM attribution are also missing from other locale READMEs (e.g. README.zh-CN.md, README.ja-JP.md) — the repo has no README drift-detection tooling, so each locale lags independently. Kept out of scope here to keep this PR a focused zh-TW sync; happy to follow up on the other locales separately.

Bring docs/i18n/README.zh-TW.md back in line with README.md:
- Add the hosted `curl ... install.sh | sh` install path plus the
  install.sh wrapper note (nexu-io#4866).
- Add the WSL2 note in the coding-agent install section and the
  WSL2 / wsl-setup.md pointer in the run-from-source line.
- Add the macOS Docker Desktop bridge-networking note.
- Add utm_source / utm_medium / utm_content attribution to the six
  open-design.ai links (nexu-io#4792).

Headings and structure unchanged; all referenced docs (wsl-setup.md,
deploy/README.md#docker-desktop-on-macos, windows-troubleshooting.md)
exist.
@lefarcen

lefarcen commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Hi @laihenyi — thanks for keeping the zh-TW README aligned with the English source. The scope here looks nicely focused; I've routed it for review.

@lefarcen
lefarcen requested a review from mrcfps July 3, 2026 05:31
@lefarcen lefarcen added size/S PR changes 20-100 lines risk/low Low risk: docs/i18n/assets only type/docs Documentation changes only labels Jul 3, 2026

@mrcfps mrcfps 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.

@laihenyi I reviewed the zh-TW README parity update against the English README. The hosted install command, WSL2 guidance, Docker Desktop note, and open-design.ai attribution links all line up, and the new relative links/anchor resolve from docs/i18n/. Thanks for keeping this locale current and scoped cleanly.

🔁 Powered by Looper · runner=reviewer · agent=codex · An autonomous AI dev team for your GitHub repos.

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

@laihenyi friendly reminder: this PR appears to be waiting on author action (merge conflict) and has had no human activity for more than 3 days.

When you have a chance, please reply here or push an update. To keep the queue manageable, PRs with no human activity for more than 5 days may be closed automatically, but they can be reopened when work resumes.

@lefarcen
lefarcen requested a review from mrcfps July 6, 2026 08:05

@mrcfps mrcfps 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.

@laihenyi I reviewed the updated zh-TW README diff against the current English README after the merge-conflict resolution. The Cloud rebrand, hosted install command, WSL2 guidance, Docker Desktop note, and open-design.ai attribution links now line up with the source README, and the new relative links resolve correctly from docs/i18n/. Thanks for keeping this locale current and for keeping the docs-only scope tight.

🔁 Powered by Looper · runner=reviewer · agent=codex · An autonomous AI dev team for your GitHub repos.

@PerishCode
PerishCode added this pull request to the merge queue Jul 9, 2026
Merged via the queue into nexu-io:main with commit 0ba89a9 Jul 9, 2026
18 checks passed
xxiaoxiong pushed a commit to xxiaoxiong/open-design that referenced this pull request Jul 13, 2026
Bring docs/i18n/README.zh-TW.md back in line with README.md:
- Add the hosted `curl ... install.sh | sh` install path plus the
  install.sh wrapper note (nexu-io#4866).
- Add the WSL2 note in the coding-agent install section and the
  WSL2 / wsl-setup.md pointer in the run-from-source line.
- Add the macOS Docker Desktop bridge-networking note.
- Add utm_source / utm_medium / utm_content attribution to the six
  open-design.ai links (nexu-io#4792).

Headings and structure unchanged; all referenced docs (wsl-setup.md,
deploy/README.md#docker-desktop-on-macos, windows-troubleshooting.md)
exist.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk/low Low risk: docs/i18n/assets only size/S PR changes 20-100 lines type/docs Documentation changes only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants