Connect GitHub

• The repo connected on the Repos tab, with the Amendary GitHub App installed. See Getting started.
• Write access for the GitHub App on that repo.
• An owner. Only owners add or change a GitHub destination.
• For a help center: the Markdown files in a folder of the repo, not the wiki.

1. On the Pages tab select Add destination, then GitHub.
2. Pick the Repo. Under Write docs to, pick A folder in the repo or The repo wiki.
3. For a folder, enter it, for example docs. Leave the branch blank for the default branch.
4. Keep Open a pull request on to get every fix as a pull request you merge. Turn it off to commit directly. A wiki is always committed.
5. Select Add destination. You land on the GitHub tab with a card for the repo.

• For a docs folder, the card shows a Help articles follow list. An owner picks the repo itself, a changelog saved before, or Changelog URL to paste a new one.
• Set it when the folder is a help center. Skip it for engineering docs: they always follow the repo’s commits. See Help articles follow.

For a help center: open the … menu on the card and select Watch help articles in this folder. Amendary watches the source-language files and links each translation to its source. Run it again to pick up new files. For Docusaurus, other versions are offered as buttons under the card.

For single files: select Browse, then Watch on a file or Watch folder. Pick As Help center or As Engineering docs.

Where Amendary looks for files:

• Starlight: src/content/docs
• Hugo: content
• Docusaurus: docs, translations in i18n/<locale>/docusaurus-plugin-content-docs/current
• Jekyll and plain folders: the folder you set.

In the Queue a fix says Open pull request or Commit to GitHub, following the card’s setting. Amendary:

• edits the wrong sentence in the Markdown file, and in each linked translation;
• writes only inside the folder or wiki you chose;
• never merges a pull request for you, and never changes application code.

A repo with no GitHub destination is read-only. Generate can add new files to the folder or wiki.

• A folder named with a language code is a language: de, fr, pt-br. A locale: line in the front matter wins over the folder name.
• A file with no language is the source. A translation must have the same path under its language folder, for example docs/billing.md and docs/de/billing.md.
• A file that matches no source is left alone. Amendary never guesses.
• One approval carries the fix into every linked translation. Missing languages are not drafted.

Once connected, follow Update GitHub docs after a release to check a release, review the fix in each language and merge the pull request.

• An owner opens the … menu on the card and selects Remove destination. Its watched pages stop being checked. Docs already written stay in the repo.
• To change the folder, branch or pull request setting, select Edit folder and branch in the same menu.
• To remove the app’s access, use Manage repos on GitHub on the Repos tab.

Missing files, write errors and checks with no result are in Troubleshooting.