morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[GH-ISSUE #2141] docs: move translated READMEs into a dedicated directory #701

New issue

Closed

opened 2026-10-15 18:27:31 +00:00 by bsakaguchi · 4 comments

bsakaguchi commented

2026-10-15 18:27:31 +00:00

Owner

Originally created by @N0zoM1z0 on GitHub (Oct 12, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/2141

Originally assigned to: @N0zoM1z0 on GitHub.

Problem

REA currently has an English README.md and 18 translated READMEs in the repository root. Keeping the translations together would make the root easier to browse while preserving language access from the main README.

Both layouts exist in other projects. RustDesk stores translated READMEs under docs/, and Coding Interview University uses translations/. OpenCode keeps them in the root. A dedicated directory is a useful organization choice for REA's current number of translations.

Proposal

Keep the English README.md in the root and move existing translations into docs/readme/, preserving their filenames and language codes.

README.md
docs/
  readme/
    README_zh.md
    README_zh-TW.md
    README_fr.md
    ...

Acceptance criteria

All languages remain accessible from the English README and translated language navigation.
Relative guide links, images, license links, and links back to English resolve from their new locations.
Documentation consistency checks continue to cover every translation and compare resolved link targets.
Website language metadata and README discovery use the new paths.
CI change classification continues to recognize translated README changes.
Existing references and compatibility expectations for old file URLs are reviewed.

Translation wording can stay unchanged apart from path updates. English remains the canonical content source; translation accuracy and synchronization still require their existing maintenance checks.

This issue records the agreed layout. The file migration will be handled separately from the current English documentation audit.

Originally created by @N0zoM1z0 on GitHub (Oct 12, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/2141 Originally assigned to: @N0zoM1z0 on GitHub. ## Problem REA currently has an English `README.md` and 18 translated READMEs in the repository root. Keeping the translations together would make the root easier to browse while preserving language access from the main README. Both layouts exist in other projects. [RustDesk](https://github.com/rustdesk/rustdesk/blob/master/README.md) stores translated READMEs under `docs/`, and [Coding Interview University](https://github.com/jwasham/coding-interview-university/blob/main/README.md) uses `translations/`. [OpenCode](https://github.com/anomalyco/opencode/blob/dev/README.md) keeps them in the root. A dedicated directory is a useful organization choice for REA's current number of translations. ## Proposal Keep the English `README.md` in the root and move existing translations into `docs/readme/`, preserving their filenames and language codes. ```text README.md docs/ readme/ README_zh.md README_zh-TW.md README_fr.md ... ``` ## Acceptance criteria - All languages remain accessible from the English README and translated language navigation. - Relative guide links, images, license links, and links back to English resolve from their new locations. - Documentation consistency checks continue to cover every translation and compare resolved link targets. - Website language metadata and README discovery use the new paths. - CI change classification continues to recognize translated README changes. - Existing references and compatibility expectations for old file URLs are reviewed. Translation wording can stay unchanged apart from path updates. English remains the canonical content source; translation accuracy and synchronization still require their existing maintenance checks. This issue records the agreed layout. The file migration will be handled separately from the current English documentation audit.

bsakaguchi

2026-10-15 18:27:31 +00:00

closed this issue
added the
i18n

documentation

P2: medium
labels

bsakaguchi commented

2026-10-15 18:27:32 +00:00

Author

Owner

@aimalexe commented on GitHub (Oct 12, 2026):

I'd suggest placing the translated READMEs under docs/, as this is a common convention in many open-source projects

@aimalexe commented on GitHub (Oct 12, 2026): I'd suggest placing the translated READMEs under `docs/`, as this is a common convention in many open-source projects

bsakaguchi commented

2026-10-15 18:27:32 +00:00

Author

Owner

@aimalexe commented on GitHub (Oct 12, 2026):

I’d like to work on this issue if that’s okay @N0zoM1z0

@aimalexe commented on GitHub (Oct 12, 2026): I’d like to work on this issue if that’s okay @N0zoM1z0

bsakaguchi commented

2026-10-15 18:27:32 +00:00

Author

Owner

@N0zoM1z0 commented on GitHub (Oct 13, 2026):

Thanks for taking this on and opening #2165, @aimalexe! We'll review the PR and help resolve the conflicts.

@N0zoM1z0 commented on GitHub (Oct 13, 2026): Thanks for taking this on and opening #2165, @aimalexe! We'll review the PR and help resolve the conflicts.

bsakaguchi commented

2026-10-15 18:27:33 +00:00

Author

Owner

@aimalexe commented on GitHub (Oct 13, 2026):

Thanks! I appreciate the help. Let me know if anything needs to be changed @N0zoM1z0

@aimalexe commented on GitHub (Oct 13, 2026): Thanks! I appreciate the help. Let me know if anything needs to be changed @N0zoM1z0

bsakaguchi referenced this issue

2026-10-15 18:28:32 +00:00

[GH-ISSUE #2383] [Tracker] Audit analysis and debugging coverage for the TIOBE top 100 languages (October 2026) #794

bsakaguchi referenced this issue

2026-10-16 21:09:12 +00:00

[GH-ISSUE #4293] [Bug] Universal Mach-O signatures report one slice as the whole file #1698

bsakaguchi referenced this issue

2026-10-16 21:15:20 +00:00

[PR #701] [MERGED] fix(native): inspect mixed-signature Mach-O slices #2181

bsakaguchi referenced this issue

2026-10-31 00:30:34 +00:00

[GH-ISSUE #3537] [Tracker] Audit and subsystem index of active bug reports (October 2026) #1313