|
| 1 | +--- |
| 2 | +name: localizations |
| 3 | +description: A skill that localizes contents into given locales. |
| 4 | +--- |
| 5 | + |
| 6 | +# Localize contents into given locales |
| 7 | + |
| 8 | +A skill that localizes contents into given locales. |
| 9 | + |
| 10 | +## How it works |
| 11 | + |
| 12 | +The skill takes input content and a list of target locales. It then translates the content into each specified locale, providing localized versions for each. |
| 13 | + |
| 14 | +### Content structure |
| 15 | + |
| 16 | +```text |
| 17 | +. |
| 18 | +├── README.md |
| 19 | +├── docs/ |
| 20 | +│ ├── *.md |
| 21 | +│ └── <any/path>/ |
| 22 | +│ └── *.md |
| 23 | +└── docs/ |
| 24 | + └── src/content/docs/ |
| 25 | + └── <locale>/ |
| 26 | + ├── index.md |
| 27 | + └── <any/path>/ |
| 28 | + └── *.md |
| 29 | +``` |
| 30 | + |
| 31 | +### Input contents |
| 32 | + |
| 33 | +Here are the list of contents for localization: |
| 34 | + |
| 35 | +- `README.md`: The main documentation file for the project. |
| 36 | +- All markdown files in the `docs` directory **and its subdirectories** (`docs/**/*.md`): The main content files for the project documentation. |
| 37 | + |
| 38 | +Both `README.md` and the `docs` tree are in scope. The **`docs`** directory is the default location for content files, but `README.md` at the project root is always included as well. |
| 39 | + |
| 40 | +Files already under `docs/src/content/docs/<locale>/` are **outputs**, not inputs—never treat configured locale-root directories as source content to be localized again. |
| 41 | + |
| 42 | +### Target locales |
| 43 | + |
| 44 | +Target locales are defined in the `rules` directory as markdown files in this skill (`rules/ko-kr.md`, for example). **To determine which locales to process, list the files in `rules/`: each `<locale>.md` file corresponds to exactly one supported target locale.** Each locale has its own set of rules and guidelines for translation, ensuring that the localized content is appropriate for the target audience. |
| 45 | + |
| 46 | +Locale identifiers use lowercase with a hyphen (for example, `ko-kr`). This is the canonical casing for both the rules filename and the output directory in this skill; keep them consistent. |
| 47 | + |
| 48 | +### Output contents |
| 49 | + |
| 50 | +All localized workshop content is stored directly under the Starlight content root, with each locale having its own subdirectory. For example, Korean content is stored in `docs/src/content/docs/ko-kr/`. |
| 51 | + |
| 52 | +Locale directories must be direct children of `docs/src/content/docs/` so Starlight recognizes them and renders its language selector. Do not add an intermediate `localizations/` directory. |
| 53 | + |
| 54 | +## Localization process |
| 55 | + |
| 56 | +There are three cases for localization. To detect which case applies, compare the **source tree** against the existing `docs/src/content/docs/<locale>/` tree, and use the **git history of the source files** to detect changes: |
| 57 | + |
| 58 | +- **Original exists, no localized version for the locale:** Create a new localized document. |
| 59 | +- **Both original and localized versions exist:** Compare the source tree against `docs/src/content/docs/<locale>/`, then run `git diff` (or `git log`) on the **source** file to find what changed since the localized version was last produced. Update only the affected sections of the localized document; do not re-translate unchanged sections unnecessarily. |
| 60 | +- **Localized version exists, but the original has been deleted:** Delete the orphaned localized document (and prune now-empty locale subdirectories). |
| 61 | + |
| 62 | +The process runs in two passes. First, the content is analyzed to identify key phrases and context. Then the `translator` agent performs the initial localization, followed by a review-and-refinement pass by the `evaluator` agent to ensure quality and consistency. |
| 63 | + |
| 64 | +> The `translator` and `evaluator` "agents" are **roles/personas**, not external tools. If no dedicated sub-agents are available, perform them as sequential personas: first adopt the translator role to produce the draft, then adopt the evaluator role to critique and refine that draft against the locale rules. Repeat the refinement loop until the evaluator's criteria pass. |
| 65 | +
|
| 66 | +### Markdown and formatting preservation |
| 67 | + |
| 68 | +Regardless of locale, the following must be preserved exactly and **not** translated: |
| 69 | + |
| 70 | +- YAML frontmatter **keys** (translate values only where appropriate, e.g. a `title`). |
| 71 | +- Fenced and inline code, including variable, function, and command names. |
| 72 | +- URLs and external link targets. |
| 73 | +- HTML tags, Markdown structure, tables, and admonition markers. |
| 74 | + |
| 75 | +Translate human-language prose, including comments inside code blocks where they are explanatory (per the locale rules). Keep heading order and document structure stable. |
| 76 | + |
| 77 | +**Heading anchors follow the localized text.** When a heading is translated, its auto-generated anchor/slug changes with it—this is expected. The requirement is that **same-document anchor links keep resolving**: whenever you translate a heading, update every in-page link that targets it (`](#...)`) to the localized heading's new slug. Do not leave a link pointing at the original English slug once the heading is translated, and do not preserve an English anchor that no longer matches its heading. Anchors that point into **non-localized** files (or external URLs) keep their original target. |
| 78 | + |
| 79 | +**Image and asset paths point to the original assets unless a localized asset exists.** Because localized files live under `docs/src/content/docs/<locale>/`, rewrite source-relative paths as needed so they still resolve to the shared asset (for example, an app lesson uses `../../_images/x.png`). Only point at a localized asset when a corresponding translated image actually exists under the locale tree. Either way, the link must resolve to a real file. |
| 80 | + |
| 81 | +### Translator agent |
| 82 | + |
| 83 | +Use the `translator` agent to perform the localization. It should follow the rules and guidelines defined for each target locale document in the `rules` directory. |
| 84 | + |
| 85 | +### Evaluator agent |
| 86 | + |
| 87 | +Use the `evaluator` agent to assess the quality of the localized content. The evaluator checks for accuracy, cultural relevance, and overall quality, following the rules and guidelines defined for the target locale in the `rules` directory. |
| 88 | + |
| 89 | +The evaluator scores the localized document against the locale's **Evaluator Scoring Rubric** (defined in the locale's `rules/<locale>.md`). The rubric uses two tiers: **Tier A** hard-fail criteria that must score 5, and **Tier B** graded criteria (1–5) that must score 4 or 5. A document passes only when **every applicable Tier A criterion scores 5 and every applicable Tier B criterion scores ≥ 4**. If anything falls short, return the document to the translator with specific notes and re-run the translate → evaluate loop until it passes, escalating to a human after the rubric's iteration cap. |
| 90 | + |
| 91 | +## DOs and DON'Ts |
| 92 | + |
| 93 | +- **Do** perform localization only for the target locales defined in the `rules` directory (one `<locale>.md` per supported locale). Do not localize into unsupported locales. |
| 94 | +- **Do** preserve Markdown structure, code, external link/URL targets, and frontmatter keys exactly (see *Markdown and formatting preservation*). |
| 95 | +- **Do** let heading anchors follow the localized heading text, and update same-document anchor links to match the new slugs so they keep resolving (see *Markdown and formatting preservation*). |
| 96 | +- **Do** point image and asset paths at the original assets (rewriting the relative path as needed so it resolves from `docs/src/content/docs/<locale>/`), unless a corresponding localized asset exists (see *Markdown and formatting preservation*). |
| 97 | +- **Do** mirror the source directory layout under `docs/src/content/docs/<locale>/`. |
| 98 | +- **Don't** treat configured locale-root directories as source input. |
| 99 | +- **Don't** reorder or restructure content; keep headings and their order stable. |
| 100 | +- **Don't** translate code, commands, or identifiers; translate explanatory prose and code comments only. |
| 101 | + |
0 commit comments