Mintlify Connect is “continuous documentation” within your workflow. It detects documentation commented in your codebase and reminds you to update the relevant documentation whenever significant code changes happen.

Screen Shot 2022-04-13 at 7.43.43 PM.png

Installation

GitHub App

All the magic happens in the GitHub App - The alerts are sent within PRs and a CI check is added to the PRs.

Installation

Set up the Connect GitHub App to the organization you would like alerts on.

Screen Shot 2022-04-13 at 7.01.04 PM.png

Notion Integration (optional)

When you link code to Notion pages or blocks, the Notion Integration will fetch the title of your page or the content of the block right inside GitHub so you know what you need to update.

Installation

  1. Install the Notion Integration through the link below. Make sure to replace <ID> with the display name of your GitHub organization.
<https://connect.mintlify.com/routes/notion/authorization?github=><ID>

Screen Shot 2022-04-13 at 7.09.08 PM.png

  1. Give access to the pages associated with your codebase.

    Screen Shot 2022-04-13 at 7.08.36 PM.png

In the future if you want to expand the scope of documents the integration has access to, share the pages with the integration.

Share-Notion-Page.gif