|
| 1 | +--- |
| 2 | +name: sync-readme-translations |
| 3 | +description: "Sync changes from the English README.md to all translated README files. Use when: updating README translations, syncing README across languages, propagating README changes to other locales." |
| 4 | +argument-hint: "Describe what changed in README.md that needs syncing" |
| 5 | +--- |
| 6 | + |
| 7 | +# Sync README Translations |
| 8 | + |
| 9 | +Propagate content changes from the English `README.md` to all translated versions, preserving each language's natural phrasing. |
| 10 | + |
| 11 | +## Target Files |
| 12 | + |
| 13 | +| File | Language | |
| 14 | +|------|----------| |
| 15 | +| `README.zh-CN.md` | 简体中文 (Simplified Chinese) | |
| 16 | +| `documents/README.zh-TW.md` | 繁體中文 (Traditional Chinese) | |
| 17 | +| `documents/README.ja.md` | 日本語 (Japanese) | |
| 18 | +| `documents/README.ko.md` | 한국어 (Korean) | |
| 19 | +| `documents/README.it.md` | Italiano (Italian) | |
| 20 | +| `documents/README.fr.md` | Français (French) | |
| 21 | + |
| 22 | +## Procedure |
| 23 | + |
| 24 | +1. **Read the English README.md** to identify the changed sections. |
| 25 | +2. **For each translated file**, read the corresponding section and apply the same change in that language. |
| 26 | +3. **Preserve localized phrasing** — translate new/changed text naturally; do not produce literal word-for-word translations. |
| 27 | +4. **Keep shared elements untranslated** — badges, image paths, links, HTML tags, table structure, and code blocks must stay identical across all files. |
| 28 | +5. **Use `multi_replace_string_in_file`** to batch all edits efficiently when multiple files need the same structural change. |
| 29 | +6. **Verify** that the number of edits matches the number of target files × changed sections. |
| 30 | + |
| 31 | +## Rules |
| 32 | + |
| 33 | +- Never remove or reorder sections that exist in a translated file but not in English — the structures are kept in sync. |
| 34 | +- Benchmark numbers (scores, case counts) are language-neutral; copy them verbatim. |
| 35 | +- If a section doesn't exist yet in a translated file, add it at the same position as in the English README. |
| 36 | +- All paths in links/images are relative to the repo root and must not change. |
0 commit comments