Translations
How DispatchAtlas localizes its documentation: the locale cohort, the current coverage, the machine-seed plus human-review pipeline, and how to contribute a translation.
DispatchAtlas serves its documentation in a cohort of twelve locales. English is the source; every other locale is a translation target. This page states what is translated today, the discipline that governs translation quality, and the steps to contribute a translation.
Locale cohort
The site registers twelve locales — English at the site root and eleven prefixed translation targets:
| Locale | Code | Direction |
|---|---|---|
| English (source) | en | left-to-right |
| Mandarin (Simplified) | zh-cn | left-to-right |
| Spanish | es | left-to-right |
| Portuguese (Brazil) | pt-br | left-to-right |
| French | fr | left-to-right |
| German | de | left-to-right |
| Japanese | ja | left-to-right |
| Korean | ko | left-to-right |
| Russian | ru | left-to-right |
| Indonesian | id | left-to-right |
| Arabic | ar | right-to-left |
| Hindi | hi | left-to-right |
Each page declares its lang, Arabic additionally renders right-to-left, and a
symmetric hreflang set plus an x-default pointing at the English page links
the cohort for search engines. A locale that has not yet translated a given page
omits that page's hreflang entry rather than pointing it at English, so the
absence is reported accurately.
Current coverage
The interface chrome — navigation, controls, search, and footer — is translated
across all twelve locales, and every documentation page currently ships in all
twelve locales; tools/translation_coverage.py reports the page-by-page
figures, including any orphaned translation a source rename would strand.
Should a future page land before its translations, the requested locale renders
the English source as a fallback so no route is ever broken, and the language
switcher always reaches every page in at least its English form. Which pages a
reviewer has attested is tracked through the review pipeline below, not on this
page.
The machine-seed plus human-review pipeline
Translation quality is a release criterion, not an afterthought. Two stages govern every translated page:
- Machine seed. A page is first drafted by machine translation against the per-locale glossary, which fixes the domain vocabulary (scheduling, dispatch, benchmark, solver, objective, constraint) to one consistent term per locale.
- Human review. A native-fluent reviewer corrects the seed for fluency, terminology, and tone before it ships. Machine-seeded copy is never published as final unreviewed text.
A page is production-ready in a locale only after a reviewer has attested it. Until then the English fallback stands, which is accurate and complete rather than partially-translated.
Contributing a translation
- Pick a page under
site/content/docs/en/and the target locale. - Create the mirror path under
site/content/docs/<locale>/with the same relative slug. Translate thetitlefrontmatter key — every page requires it. Add a translateddescriptionas well when the English source carries one; most existing translations predate that key and shiptitleonly, and a page without it renders with no meta description rather than falling back to the English text. - Translate the body, honoring the locale's glossary so domain terms stay consistent with the rest of that locale.
- Keep every code block, command, identifier, and figure reference identical
to the source — only natural-language prose is translated. Internal
documentation links take the target locale's prefix (for example, the German
page links to
/de/getting-started/quick-start/where the English source links to/getting-started/quick-start/); external link targets stay identical. - Open a contribution for native-fluent review. Once attested, the page ships
in that locale and its
hreflangentry is added to the cohort.
See the Contribution Guide for the repository workflow and the review process that applies to every change.