Start here

Translating QuantEcon lectures

This manual describes how QuantEcon's lectures are translated and reviewed. It is for the translators and editors who review the translated editions.

Last updated

QuantEcon writes its lecture series in English and publishes them in other languages too. QuantEcon's translation engine, action-translation, drafts each translation. Translators and editors who are native speakers of the language then review it on GitHub, one lecture at a time.

Start here

If you are new, read these four pages in order.

  1. How an edition is builtThe two phases of an edition, and why your review matters.
  2. Access and set-upYour GitHub account, the invitation and where to find your work.
  3. How a review round worksOne lecture, from draft to merge to the next draft.
  4. Reviewing on GitHubHow to suggest changes and approve, step by step.

The two phases

An edition is built in two phases.

  • Initial translation. Lectures are drafted and reviewed one at a time, and each review improves the engine before the next lecture is drafted. Most of this manual describes this phase.
  • Sync. Once the edition is complete, changes to the English lectures reach it as sync pull requests. The review process for this phase is still being designed.

See How an edition is built.

Languages

Each language has its own page for its terms, house style and open questions. The pages for Japanese and Malayalam are ready. Pages for the other languages are to come.

Languages lists every edition, with its website and its phase.

How to use this manual

  • Read the general pages once. They describe the process for every language.
  • Keep your language page open while you review. It holds the terms and house style for your language.
  • Check your edition's REVIEWING.md, where it has one, to see which lecture comes next. The Japanese edition has one: REVIEWING.md. Where it differs from this manual, follow this manual.
  • Check unfamiliar words in Vocabulary.

In development

This manual is in development, and its pages change as the process settles. Every page shows the date it was last updated, and What's changed lists the changes, newest first.

If something here is unclear or seems wrong, mention @mmcky on your current pull request or issue.