Checklist

Connecting a new app to the editor is a one-off job of about an hour. After that, developers only write English and push.

The app must use i18next (for React, through react-i18next). If it uses its own translation code, it can still sync its English, but the live preview won't work.

The steps

In the app (Preparing the App):

• Install the @abair/i18n package.
• Keep only English in the repo, in one English file.
• Download the Irish from the editor at build time, into a gitignored file.
• Connect i18next to the editor's live preview.
• Let the editor show the site in a frame.
• Make the deploy runnable on demand, so translators can publish.
• Add a Translations section to the app's README.
• List the app so it gets update pull requests when the package changes.

In the editor (Registering the Project), done by an admin:

• Add the project, its repo and its English file.
• Watch its branches and set each one's live preview address.
• Set its publish workflow.
• Make sure the editor can read the repo and receives its pushes.
• Sync each branch once.

Check it works:

• The project shows as Ready on the admin page.
• Push a new English string: it appears in the inbox.
• Translate it, publish, and see it on the site.
• Open the live preview: it says Connected, and Pick string jumps to the text you click.

If the app used the old editor, also follow Moving from the Old Editor. The order of the steps matters there.