← Help Center

Getting started

Amendary keeps your Notion help pages aligned with what you ship. Here is how to set it up.

What does Amendary actually do?

When your code changes, Amendary checks the pages you have mapped to that repo: Notion pages, or markdown files in the repo’s docs folder or wiki. Engineering docs are checked against commits once a day. Help-center pages follow the repo’s change trigger, which you set per repo on the Repos tab: commits (the default), a branch, GitHub Releases, or tags. If a change makes a sentence on a page wrong, it drafts the correction with the evidence attached. Confident corrections with complete context are applied automatically; anything uncertain waits in the Queue. Switch to review mode in Settings and every correction waits for you instead.

How do I connect my GitHub account?

From the Repos tab in your dashboard, select “Connect GitHub”. GitHub asks you to authorize Amendary, then Amendary lists the accounts and organisations where it is already installed and you pick one, or install it on a new one and choose which repos to share. Amendary reads those repos; writing docs to a repo is a separate destination you turn on per repo on the Pages tab. To change which repos are shared later, use “Manage repos on GitHub” next to the account on the Repos tab; changes there sync back automatically. A GitHub account or organisation can be connected to more than one Amendary workspace; each workspace picks its own pages and destinations.

How do I add a destination for my docs?

From the Pages tab, select “Add destination” and pick where your docs live. For a Notion workspace, Notion’s picker asks which pages (or their parent) Amendary may see; this only makes them discoverable, nothing is watched yet, and if a page is missing later you can reconnect or paste its link into “Add by Notion URL”. For a GitHub repo, choose the repo and whether generated docs are written to a folder (committed or as a pull request) or the wiki.

Do I need to do anything else after connecting?

Yes: watch the pages that matter. On the Pages tab, open “Browse workspace”, find a page (databases expand to the pages inside them), select “Watch”, and pick the repo it describes and its type. That one step is what tells Amendary where to pay attention; discovered pages you do not watch are never read or edited. See Pages & mapping for details.

How do I see a real correction on day one?

Use “Replay a recent release” on the Home checklist. Pick a repo and one of its recent GitHub Releases, and Amendary checks your mapped customer-facing pages against it as if it had just been published. The result tells you how many pages were checked and how many corrections were drafted, with a link to the Queue.

Do I need help to set it up?

No. Setup is self-serve: sign in, connect GitHub and Notion, and map your first pages. The steps above are the whole process, and the free trial starts right away with no card.