GitHub
Keep a Markdown help center up to date, in every language
Your help center is Markdown in a GitHub repo, with a folder per language. After a release, some files say the wrong thing. Amendary finds them and fixes every language in one pull request you review and merge.
- Fix lands as
- A pull request or commit
- Languages
- Every language, one pull request
- Missing languages
- Not drafted
- Follows
- A repo or your changelog
The problem
The code changed in one pull request. The help files in docs/, docs/de/ and docs/ja/ did not, because nobody touched them in that pull request.
Code review does not catch it. Translators do not see it. Customers find it.
What happens on a release
- Amendary reads what shipped: a release, tag or commit of your repo, or a new entry on your public changelog.
- It checks the source-language files you watch. Translations are found by folder layout: Docusaurus, Hugo, Starlight, Jekyll, or a folder per language such as docs/de/.
- It finds the sentence that became wrong and drafts the fix, with the change that proves it. If nothing became wrong, there is no fix.
- It carries the fix into each translated file. Numbers, versions and names must match in every language, or that language waits for you.
- You approve once in the Queue. Every ready language lands in one pull request, or one commit if you chose direct commits. See Connect GitHub.
- Nothing reaches your site until you merge the pull request. Amendary never merges it for you.
One release, three languages
This change made 1 article out of date, 2 other languages
Release v2.8: CSV import now accepts files up to 50 MB.
Sentence now
You can import CSV files up to 10 MB.
Replacement
You can import CSV files up to 50 MB.
Other languages (2)
- deReady
Sentence now
Sie können CSV-Dateien bis 10 MB importieren.
Replacement
Sie können CSV-Dateien bis 50 MB importieren.
- jaReady
Sentence now
最大 10 MB の CSV ファイルをインポートできます。
Replacement
最大 50 MB の CSV ファイルをインポートできます。
One approval opens one pull request that changes docs/import.md, docs/de/import.md and docs/ja/import.md. You can dismiss one language alone.
What to check before approving
- Check the release against the file. In the example above, CSV import must really accept 50 MB now.
- Read each translated replacement. German and Japanese must state the same 50 MB limit.
- Read the pull request diff before merging.
What it does not do
No new docs site
Your files stay in your repo. Amendary does not build or host your site.
Writes only where you allow
GitHub writing is off by default. When on, it writes only inside the folder you chose.
No missing languages
It fixes the translations you have. It does not draft a language that is missing.
Never edits code
Only Markdown files in your docs folder. Application code is only read.
Setup in four steps
- 1On the Pages tab, select Add destination, pick GitHub, then the repo and its docs folder. Keep pull requests on if you want to merge each fix yourself (owners).
- 2On the GitHub card, set Help articles follow: the repo itself or your changelog URL (owners).
- 3Find the articles and watch the source-language files. Each translation is linked to its source.
- 4On Home, run a first check on recent changes instead of waiting a day. Then open the first fix in the Queue.
Where to go next
- Update GitHub docs after a releaseA release-to-review walkthrough for a docs folder.
- Multilingual supportHow one fix reaches every language.
- Connect GitHubSupported layouts and how languages are found.
- GitHub integrationRead access, writing and delivery.
- Help-center languagesHow a fix is carried into each language.
- Daily checksHow fixes are found and held.
- PricingPlans by help articles watched, translations included.
Try Amendary on your own help center
Connect Notion, GitHub, Zendesk or Intercom and pick the articles to watch. Your first check shows what Amendary would fix, with the change as proof.
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.