Mapping pages to repositories

Amendary keeps a documentation page in sync by comparing it against a connected code repository. Before that can happen, you need to tag the page with the right type and map it to the repository (or repositories) whose changes should be checked against it.

You need a connected GitHub repository and a connected Notion workspace, or a page living in a repository's docs folder or wiki, before you can map anything. Any member of your workspace can tag and map pages: this isn't an owner-only action.

Choose a page type

Every page you bring into Amendary is tagged as one of two types, and that tag decides how Amendary judges whether the page has gone stale.

Technical docs: judged against a summarized version of the code changes in your repository. Use this for engineering-facing material such as internal wikis, architecture notes, and runbooks.
Customer success: judged against your repository's published release notes, that is, what shipped, described the way a customer would read it, rather than the raw code diff. Use this for help-center articles and other customer-facing content.

<aside> ✏ A page can also be marked excluded, which takes it out of consideration entirely. Use this for pages you don't want Amendary watching at all.

</aside>

Picking the right type matters because it changes what evidence a correction is based on. A customer-success page that gets compared against raw code changes would end up flagged over internal details your customers never see, so keep the tag aligned with who actually reads the page.

Map a page to one or more repositories

Open the page in your dashboard and select its Type to set it to Technical docs or Customer success.
Choose Map to repository and select the repository whose changes should keep this page current.
Repeat the selection if more than one repository should feed this page. A single page can be mapped to more than one repository, and a single repository can feed more than one page.

Result: the page now appears in that repository's mapped-pages list, and Amendary includes it the next time that repository is checked.

<aside> ✏ Mapping a page doesn't check it immediately. The page picks up its first review on the next scheduled check, or the next time you trigger a check for that repository.

</aside>

Subject pages compared with context pages

When you map a page, you're setting its role for that repository: whether it's the page being judged, or background material used to judge other pages.

Role	What it does	When to use it
Subject	The page Amendary checks for staleness and may flag for a correction.	The documentation page you want kept accurate.
Context	Read alongside a subject page's evidence, but never itself flagged.	Supporting material, such as a glossary or an architecture overview, that helps judge other pages correctly but shouldn't get edited on its own.

Choose the role that matches what you want to happen to the page: if you never want a page corrected automatically, map it as context rather than as a subject.