← Help Center

Update GitHub docs after a release

Code and Markdown in the same repo can still disagree. This guide takes one help article in a docs folder, and its German translation, from the release to a merged pull request.

Before you start

  • The repo’s docs folder is added on the Pages tab, with Open a pull request on. See Connect GitHub.
  • An owner. Only owners add or change a GitHub destination.
  • Help center is on Review first, so you see the first fix before it is applied.

1. Follow what shipped and watch the folder

  1. On the GitHub card on the Pages tab, an owner sets Help articles follow to the repo.
  2. Open the … menu on the card and select Watch help articles in this folder. Amendary watches the source files and links each translation, such as docs/de/export.md to docs/export.md.
  3. On the Repos tab, set What counts as shipped to GitHub Releases if releases are what your customers get.

2. Check a release

Daily checks find new releases. To see a result today, open Check recent changes on Home and select Check the last release. A release that makes nothing wrong drafts nothing.

In this made-up example, a release raises export history from 30 to 90 days.

Before: You can export up to 30 days of history.

After: You can export up to 90 days of history.

de: Sie können den Verlauf von bis zu 90 Tagen exportieren.

3. Review the fix and each language

  • Open the fix in the Queue. Read the change it links to.
  • Check the source sentence first. If it is wrong, select Dismiss.
  • Then read each language row. A Ready row passed the checks. A Check it or Not found row needs you.
  • Select Dismiss this language for one you do not accept. The other languages still go.

4. Open the pull request and merge it

  • Select Open pull request. The source file and each Ready translation are edited on the amendary/docs branch, in one pull request. Later fixes join it while it is open.
  • Read the diff in GitHub and merge it. Amendary never merges for you.
  • For 30 days, Undo in the Queue writes the old text back. See Review and undo.

Languages

A folder named with a language code is a language, such as de or pt-br. A translation needs the same path under its language folder. Missing languages are not drafted. More in Help-center languages.

If no fix appears

  • Check that the files are watched and the card follows the repo.
  • Check that a release exists. With GitHub Releases chosen and none published, nothing is checked.
  • Check that the GitHub App can write to the repo, and whether the pull request is still open.
  • More in Troubleshooting.

Engineering docs

Docs for engineers in the same repo work the same way, but they follow every commit on the default branch, not releases. Watch them with Browse, then Watch, then As Engineering docs. See Pages & mapping.

More

Try Amendary with GitHub

Connect GitHub, choose the pages or articles to watch, and review proposed corrections with the change behind each one.

Free for 14 days with no card, and every edit waits for your review. Or free forever with your own Anthropic API key. Code is never touched.