[PR #4441] [MERGED] docs(i18n): explain translation contribution entry points #6245

New issue

Closed

opened 2026-10-31 01:12:58 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:12:58 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4441
Author: @deuxdoom
Created: 10/16/2026
Status: ✅ Merged
Merged: 10/16/2026
Merged by: @N0zoM1z0

Base: main ← Head: docs/translation-contribution-guide

📝 Commits (4)

ef42156 docs(i18n): explain translation contribution entry points
1f51459 docs(i18n): preserve canonical README link destinations
7b901d4 Merge branch 'main' into docs/translation-contribution-guide
83837db docs(i18n): resolve README paths through the locale inventory

📊 Changes

2 files changed (+21 additions, -0 deletions)

View changed files

📝 CONTRIBUTING.md (+17 -0)
📝 docs/readme/README_ko.md (+4 -0)

📄 Description

Summary

Translation contributors currently have to discover the website's PO workflow through its separate README. Add a translation section to CONTRIBUTING.md and explain the Korean README and website translation entry points.

The Korean README names the PO catalog and translation guide as inline paths and routes readers through its existing contribution-document link. Clickable website-guide navigation lives in CONTRIBUTING.md, preserving the required English/translated README link alignment.

Scope

Documentation only: no runtime, CLI/MCP contract, dependency, translation-catalog, or generated-output changes. No capability scope decision applies; no separate issue is linked for this focused onboarding correction.

Validation performed

Windows x64, Node.js 24.18.0 / npm 11.16.0:

Before the review fix, npm run docs:check reproduced docs/readme/README_ko.md: documentation links differ from README.md.
After the fix, npm run docs:check passed, including all 5 README consistency tests.
npm run test:focused -- tests/boundary/filesystem/documentationFacts.test.ts passed (1 test), covering canonical links and link-drift rejection.
npm run check passed. Its initial run encountered formatting errors in pre-existing, untracked NativeAOT obj/ build files; those files were temporarily moved aside for the check and restored afterward.
npm run check:fast passed in the pre-push hook.
git diff --check passed.

The review issue was caused by two Korean-only Markdown destinations. The fix keeps navigation in the shared contribution guide rather than adding checker exceptions; no related checker cleanup remains.

Full website preparation, visual browser checks, and real-provider workflows were not run.

Maintainer follow-up on Linux (83837dbb35254178a2e073162b395b14bc5f374d): use the existing language inventory's readme field, since locale IDs do not always match README suffixes. Verified all 20 listed paths exist; npm run docs:check passes, including five README consistency tests. Runtime and translation catalogs are unchanged. Current-head CI (including website and title checks) and automated review passed; both review threads are resolved.

Author readiness

Human owner: @deuxdoom

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare this PR ready for initial maintainer review.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/4441 **Author:** [@deuxdoom](https://github.com/deuxdoom) **Created:** 10/16/2026 **Status:** ✅ Merged **Merged:** 10/16/2026 **Merged by:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Base:** `main` ← **Head:** `docs/translation-contribution-guide` --- ### 📝 Commits (4) - [`ef42156`](https://github.com/morluto/rea/commit/ef421561e6e66cb768aa3a343e4da0651f48d314) docs(i18n): explain translation contribution entry points - [`1f51459`](https://github.com/morluto/rea/commit/1f51459585880f1881c8939a4f089f29cd0c778c) docs(i18n): preserve canonical README link destinations - [`7b901d4`](https://github.com/morluto/rea/commit/7b901d4934a230db4327db83fd346177db630c5b) Merge branch 'main' into docs/translation-contribution-guide - [`83837db`](https://github.com/morluto/rea/commit/83837dbb35254178a2e073162b395b14bc5f374d) docs(i18n): resolve README paths through the locale inventory ### 📊 Changes **2 files changed** (+21 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `CONTRIBUTING.md` (+17 -0) 📝 `docs/readme/README_ko.md` (+4 -0) </details> ### 📄 Description ## Summary Translation contributors currently have to discover the website's PO workflow through its separate README. Add a translation section to `CONTRIBUTING.md` and explain the Korean README and website translation entry points. The Korean README names the PO catalog and translation guide as inline paths and routes readers through its existing contribution-document link. Clickable website-guide navigation lives in `CONTRIBUTING.md`, preserving the required English/translated README link alignment. ## Scope Documentation only: no runtime, CLI/MCP contract, dependency, translation-catalog, or generated-output changes. No capability scope decision applies; no separate issue is linked for this focused onboarding correction. ## Validation performed Windows x64, Node.js 24.18.0 / npm 11.16.0: - Before the review fix, `npm run docs:check` reproduced `docs/readme/README_ko.md: documentation links differ from README.md`. - After the fix, `npm run docs:check` passed, including all 5 README consistency tests. - `npm run test:focused -- tests/boundary/filesystem/documentationFacts.test.ts` passed (1 test), covering canonical links and link-drift rejection. - `npm run check` passed. Its initial run encountered formatting errors in pre-existing, untracked NativeAOT `obj/` build files; those files were temporarily moved aside for the check and restored afterward. - `npm run check:fast` passed in the pre-push hook. - `git diff --check` passed. The review issue was caused by two Korean-only Markdown destinations. The fix keeps navigation in the shared contribution guide rather than adding checker exceptions; no related checker cleanup remains. Full website preparation, visual browser checks, and real-provider workflows were not run. Maintainer follow-up on Linux (`83837dbb35254178a2e073162b395b14bc5f374d`): use the existing language inventory's `readme` field, since locale IDs do not always match README suffixes. Verified all 20 listed paths exist; `npm run docs:check` passes, including five README consistency tests. Runtime and translation catalogs are unchanged. Current-head CI (including website and title checks) and automated review passed; both review threads are resolved. ## Author readiness Human owner: @deuxdoom - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:12:58 +00:00