Skip to content

Translations

This documentation is written in English. To make it useful to more people, we also publish machine-translated editions of it, and this page explains what that means for you and how to help improve them.

What's available

Translated documentation is currently a preview in twelve languages: Deutsch, español, français, हिन्दी, 日本語, 한국어, português (Brasil), русский язык, Türkçe, українська мова, 简体中文 and 繁體中文. Pick one from the language switcher at the top of any page. More languages may follow once these have proved themselves.

The API reference is not translated: the translated site links to the single English one.

English is the source of truth

If a translated page and its English original disagree, the English page is correct. Every page of a translated site opens with one of three notes saying where it stands:

  • Machine translation — the page was translated automatically and links to its English original.
  • Translation behind the English page — the English original changed after the page was translated, so parts of it may be out of date until the translation catches up.
  • Shown in English — there is no current translation of the page, so you are reading the English text.

How the translations are made

Translated pages are machine-generated by a tool in this repository from the English pages under docs/, guided by two human-written inputs per language: a style guide (register, tone, typography, how to handle jokes and idioms) and a glossary (which terms stay in English, and the required and forbidden renderings for the rest). The generated text is never edited by hand. Every improvement goes into those inputs instead, so it survives the next time the pages are regenerated.

Reporting a translation problem

Found a wrong term, an awkward sentence, or a translation that says something the English doesn't? Open an issue with the language, the page and the passage; reports from native speakers are especially valuable. If you know the fix, propose it directly as a pull request against that language's style guide (instructions.md) or glossary (glossary.json) under i18n/ — the correction then reaches every affected page the next time the translations are regenerated. Problems with the English text itself are fixed in the pages under docs/, like any other documentation change.