← Integrations

GitHub integration

Amendary reads what lands in your repos to see what shipped. It writes only to a docs folder or wiki, and only after an owner turns that on. Here is what to check before you connect.

Install the GitHub App
Connect
Install the GitHub App. Read-only until you turn on docs.
A fix lands as
A pull request you merge, or a commit.
Languages
Every translation file in a Markdown help center.
Generate docs
New Markdown pages in your docs folder or wiki.

What it reads

The commits that land on the default branch, releases and tags, the files each change touched, and the code after the change. Amendary keeps a short summary of each change with a link to it. Raw diffs are discarded.

Markdown files in the docs folder or wiki you choose appear on the Pages tab. Prose files (Markdown, docs, help, legal, marketing) are never used as evidence of how the product behaves.

Amendary stores only the App’s installation id. It makes a short-lived token for each request, so there is no long-lived GitHub token in the database.

What it changes

Only docs, and only in repos where a workspace owner turned on GitHub docs. Each repo has one target: a folder (for example docs) or the wiki.

A repo with GitHub docs off is read-only. Amendary never changes code or repo settings. A GitHub page maps only to the repo it lives in.

Permissions

The App asks for the permissions on GitHub’s install screen, for the repos you pick. That screen is the exact list.

Write access is used only where GitHub docs is on, and only in the chosen folder or wiki. Amendary listens to two events, installation and installation_repositories, so the repo list stays in sync with GitHub.

How a fix lands

  1. Once a day, Amendary checks what shipped. Engineering docs are checked per landed commit. Help center pages follow what is set on the destination’s card, under Help articles follow: a repo, or each new entry on your public changelog.
  2. New teams start on Review first: every fix waits for you. On Apply automatically (paid plan or your own key), a fix still waits when it states a value the change does not back up, removes content, or adds new text.
  3. In a folder, a fix opens a pull request (the default) or commits to the branch. Amendary never merges a pull request for you. A wiki fix is always a commit.
  4. A docs folder can be a Markdown help center. Translations are found by folder layout (Docusaurus, Hugo, Starlight, or docs/<locale>/), and a fix is carried into each one. Missing languages are not drafted.

Undo and disconnect

Undo is in the Queue for 30 days. It writes the old text back to the file, but only if nobody edited it since.

Removing a repo or the App from Amendary deletes its fixes, check results and product-update entries. Reconnecting does not bring them back. Nothing in the repo changes. To remove access on GitHub too, uninstall the App there.

Generate and cleanup

Generate docs writes new Markdown pages to the docs folder or wiki. If docs are already there, it follows their layout.

Cleanup checks the pages you pick against your code and its history, and says which to keep, fix or retire, with the proof. It copies each repo you pick to a temporary folder on our server and deletes the copy when its search ends. It never edits a page.

Generated pages in a docs folder get a diagram, saved as an SVG in a diagrams folder next to the page. Diagrams are in early access. Suggesting a diagram for an existing page, and product updates, are Notion only.

Generate docs and cleanup spend credits, shown before the run.

Next steps

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.