Skip to content

Translations

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

What's available

Translated documentation is currently a preview, published in four languages: Simplified Chinese, Japanese, Korean and Brazilian Portuguese. Pick one from the language switcher at the top of any page.

Every translated page opens with a note saying it was machine-translated and linking to its English original. The API reference is not translated: every language 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. Two situations are called out on the page itself:

  • A page that hasn't been translated yet shows the English text, with a note saying so.
  • A page whose English original changed after it was translated carries a warning that it may be behind, until the translation catches up.

How the translations are made

Translated pages are 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 a translation issue with the language, the page and the passage; reports from native speakers are especially valuable, and maintainers track these with the translation label. If you know the fix, propose it directly as a pull request against that language's style guide or glossary under i18n/languages/ — the correction then shows up on 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.