Amendary for GitHub
GitHub is where the evidence comes from. The Amendary GitHub App reads what landed in your repos so it can tell which documentation claims are now wrong. Writing docs back to a repo is a separate choice you make per repo, and it is off until you make it.
What the App reads
The App reads repository contents and metadata: the default branch, the commits that landed on it, published releases and tags, the changed files in each unit of change, and the code after the change for the values a page names. Short summaries of each change are kept, with the changed paths and a link to the commit or release. Raw diffs are processed and discarded.
Amendary stores only the installation id and mints a short-lived token per request from the App’s key. There is no long-lived GitHub token in the database.
When checks run
Engineering docs are checked per landed commit on the default branch, one merged pull request or direct commit at a time, once a day. Customer-facing pages follow the repo’s change trigger: commits by default, or a branch you name, published GitHub Releases, or new tags. Nothing is checked per open pull request. Prose files in the repo (Markdown, docs, help, legal, marketing) are not treated as evidence of product behaviour.
A newly connected repo starts watching from its default branch head, and the repo card shows the date. To see a result on day one, replay a recent release from the Home checklist.
GitHub docs writing: opt-in and off by default
Connecting a repo gives Amendary read access only. If your docs live in the repo, a workspace owner adds the repo as a destination on the Pages tab and picks one target: a folder (for example docs) or the repo wiki. Each repo has one target, and only owners can add or remove it, since it grants write access to that repo.
A repo with GitHub docs off is strictly read-only. The App never touches a repo you have not enabled, never changes settings, and never changes code. It writes docs only.
How a correction is delivered
Markdown files already in the chosen folder or wiki appear on the Pages tab as pages. Give them an audience and a shape, and they are checked like Notion pages. A GitHub page maps only to the repo it lives in.
For a folder target you choose the delivery mode: commit directly to the branch, or open a pull request you review and merge. Several documentation changes can collect in the same open PR. Approval in Amendary and merging in GitHub are separate steps, and auto mode on a paid plan never merges a docs PR for you. A wiki target is written directly; the pull-request option does not apply to wiki edits. The walkthrough is in Keep GitHub documentation in sync with code.
Permissions the App requests
The install screen on GitHub lists the exact permissions. Our production setup grants these repository permissions and nothing else.
For reading evidence
- Contents: read, to read the changed files and the code after a change.
- Metadata: read, to list repos, branches, releases and tags.
For writing docs to a repo you enabled
- Contents: read and write, to commit a docs file to the folder or wiki you chose.
- Pull requests: read and write, to open or update the docs pull request.
The App subscribes to two webhook events, installation and installation_repositories, so the list of shared repos stays in sync when you change it on GitHub. It asks for user authorization during installation so the person installing it is tied to the workspace that connects it. It does not request access to issues, actions, secrets, or organisation settings.
Boundaries
- Code is never changed. Only docs, only in repos where GitHub docs writing is on.
- One docs target per repo: a folder or the wiki, never both.
- A GitHub account or organisation can be connected to more than one Amendary workspace.
- Disconnecting removes the connection from Amendary; uninstall the App on GitHub to revoke access there.
The full account of what is stored, sent and deleted is on the Security page. Setup steps are in Getting started.
See the first correction on your own docs
Connect GitHub and the docs you already keep in Notion or GitHub. The first check runs on a recent release, so you see a correction with its evidence before you decide anything.
Free for 7 days, no card. You approve every edit. Code is never touched.