feat: add i18n developer experience tooling#384
Merged
Conversation
Add TypeScript-based i18n scripts under website/i18n/ that detect missing, stub, and outdated translations by comparing English source docs against locale directories (ja, ko, zh). - `make i18n-sync`: generates stubs, removes orphans, updates status - `make i18n-check`: CI-friendly dry-run that exits 1 on missing files
Run translation check on every pull request. When missing translation files are detected, the workflow posts a bot comment with a table of missing files and instructions to run `make i18n-sync`.
When a PR is merged, scan translation-status.json for stub/outdated entries and create per-language GitHub Issues with rich templates, labels (translation, good first issue, lang:xx), and contribution guide links.
Show a warning banner at the top of doc pages when `translated: false` is set in frontmatter. The banner displays a localized message and a link to contribute translations.
Run `make i18n-sync` to generate stub files for the missing throttle.md in ja/ko/zh locales, and create the initial translation-status.json tracking all 128 doc files across 3 languages.
Remove orphan toSorted.md files and update translation-status.json to reflect upstream translations for throttle.md.
hg-pyun
force-pushed
the
feat/i18n-dx-tooling
branch
from
796359c to
29650db
Compare
The root prettier config uses @ianvs/prettier-plugin-sort-imports which requires @vue/compiler-sfc for .vue files. Since this dependency only exists in the website workspace, exclude .vitepress directory from the root prettier check to fix CI.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a complete i18n synchronization system that automatically detects missing/outdated translations across all supported locales (ja, ko, zh), generates English-content stubs, and creates GitHub Issues for community contributors — eliminating the risk of silently shipping incomplete translations when new APIs are added.
Architecture Overview
Banner
Translation Status Tracking
How It Works for Contributors
make allgenerates English docsmake i18n-sync→ stubs auto-generated for all localestranslated: true, submits PR