After the initial translation

Sync reviews

After its initial translation, an edition follows the English lectures through sync pull requests. The review process for these pull requests is still being designed. This page explains what a sync changes and what happens in the meantime.

Last updated

When syncs start

During the initial translation, each lecture is drafted and reviewed on its own pull request. See How a review round works.

After that phase, the edition follows the English lectures. When a change to an English lecture is merged, action-translation translates the change and opens a sync pull request in the edition's repository. How action-translation works explains the mechanics.

The published editions already receive sync pull requests: see Languages. An edition in its initial translation, such as the Japanese or Malayalam edition, receives none. Its sync pull requests start once all of its lectures are merged.

What a sync changes

A sync pull request changes only the sections of a lecture whose English changed. A section is the text under one main heading, including any smaller headings inside it.

  • Every other section stays exactly as it is, including the corrections from your review.
  • In a section whose English changed, the engine updates the whole section, starting from its current translation. Your earlier corrections in that section may change.
  • A section that is not in the English is removed by the next sync of that lecture. Do not add sections or explanations that the English does not have. Suggest them for the English lecture instead: see Errors in the English.

The action-translation documentation describes this behaviour in its quick start and its questions and answers.

Who handles sync pull requests

If you notice a problem in a sync pull request, comment on the line and mention @mmcky.

A sync pull request can also carry automated reviews, from the engine and from GitHub Copilot. They need no attention from you.

To report a problem in a lecture that is already published, open an issue in the edition's repository. See Communication.

Later: editors approve and merge

During the initial translation, @mmcky merges every pull request, because each merge is tied to a change in the engine. Once an edition is complete and runs on a stable release of action-translation, its editor will approve and merge the edition's pull requests.

Changes to this manual, including this page, are listed on What's changed.