Publishing documentation to GitHub

Amendary can deliver corrections and generated documentation straight to a connected repository instead of (or alongside) Notion. This applies to repositories where your documentation lives in a docs/ folder or in the repository's wiki. You need to be signed in as the repository owner to turn this on, and the repository must already be connected through GitHub.

By default, writing to GitHub is turned off. Turning it on is an explicit, opt-in step per repository, so no repository is written to until you choose to enable it.

What "publishing to GitHub" means

Once enabled for a repository, two kinds of content can be delivered there:

Either way, the correction or the generated page always keeps the option to arrive as a direct file edit or as a pull request, depending on how you configure it.

<aside> ✏ Corrections and generated docs are still judged and drafted the same way regardless of destination. Turning on GitHub delivery changes where the result lands, not how it's produced.

</aside>

Turn on GitHub publishing for a repository

  1. Open the repository's settings from your connected repositories list.
  2. Turn on Publish to GitHub.
  3. Choose the target: Docs folder or Wiki.
  4. If you chose Docs folder, enter the folder path (for example, docs) and the branch to write to.
  5. Choose whether changes are written directly to the branch or delivered as a pull request.
  6. Save your changes.

Result: the repository's card now shows GitHub as an active delivery destination. The next correction or generation run for this repository writes to the location you configured.

Choosing direct writes or a pull request

Option What happens Best for
Direct to branch The correction or generated page is committed straight to the branch you specified Teams comfortable letting confident, audited changes land immediately
Pull request The change is opened as a pull request against your branch for review before merging Teams that want a human review step in GitHub itself, in addition to (or instead of) Amendary's own review queue

<aside> ✏ The pull request option is a delivery choice, separate from your workspace's review mode (automatic corrections versus approval-first). You can combine either review mode with either delivery style.

</aside>