Proposal: Add localized README files for non-English users
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 125k
- Forks
- 19.4k
- PR merge metrics
- PR metrics pending
Description
What is the issue?
Codex has a global user community, but the repository README is currently available only in English.
I would like to propose adding localized versions of the README to make the project more accessible to developers who are more comfortable reading documentation in other languages.
A possible structure could be:
README.md— English (canonical/source of truth)README.zh-CN.md— Simplified ChineseREADME.zh-TW.md— Traditional ChineseREADME.ja.md— JapaneseREADME.ko.md— Korean- Additional languages could be added gradually based on community interest.
The main README could include a small language selector near the top, for example:
English | 简体中文 | 繁體中文 | 日本語 | 한국어
Suggested maintenance approach
To reduce maintenance overhead:
- Keep
README.mdas the canonical version. - Localized READMEs should preserve commands, URLs, package names, and product names exactly as written in the English version.
- Each localized README could mention that the English README is the authoritative and most up-to-date version.
- Languages could be introduced gradually rather than adding many translations at once.
- Community members could help identify outdated translations through documentation issues.
I would be happy to prepare an initial Simplified Chinese translation (README.zh-CN.md) as a proof of concept if contributions for this type of documentation change are welcome.
Where did you find it?
Repository README:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading README.md and reviewing the proposed README language filenames and selector. Confirm the maintainers' preferred scope and maintenance approach before preparing the suggested README.zh-CN.md proof of concept. Done should include an accurate translation that preserves commands, URLs, package names, and product names, while identifying README.md as authoritative.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, localization
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100