Integrations

Mintlify integration

Configure or disconnect an existing Mintlify connection and manage access to your documentation repository.

Mintlify integration

Mintlify can't be connected from Integrations any more. To connect a Mintlify docs repository, use the GitHub integration and choose that repository as the Knowledge base repository. This page is for workspaces that already have the Mintlify card.

The Mintlify card reads “Connect your Mintlify documentation hosted on GitHub”. The connection uses the Pageloop GitHub App installed on the GitHub account that holds your Mintlify docs repository, including its MDX pages and docs.json.

Before you begin

Sign in as an Admin to configure or disconnect Mintlify. Editors and Contributors see Integrations read-only.

Configure Mintlify

  1. Open Integrations from the sidebar, or Settings → Workspace → Integrations. Find Mintlify under Knowledge base. The card shows Connected and a gear button.

  2. Select the gear to open Configure GitHub Documentation.

    • Select Repository: choose <your docs repository> from Choose a repository.... The list shows the repositories granted to the Pageloop app when it was installed.
    • Documentation Path: enter the folder inside the repository that holds docs.json and the pages. Leave it as . when the repository contains only your docs.
  3. Select Save Configuration. The Configuration saved toast confirms: “GitHub repository configuration has been updated successfully.”

What Pageloop reads and writes

Pageloop reads the chosen repository and folder as your knowledge base: docs.json navigation, MDX pages, and their frontmatter. When an update is accepted, Pageloop edits the MDX page on a branch, updates docs.json navigation when a title changes, and opens a pull request titled Update: <article title> for you to review and merge on GitHub.

Mintlify can hold the Knowledge base role, but not Ticketing. It does not watch product code. Configure code repositories and merged pull requests through the GitHub integration's Product repositories.

Disconnect Mintlify

  1. Point at Connected on the Mintlify card; it changes to Disconnect. Select it to open Disconnect Mintlify?.
  2. If Mintlify holds the Knowledge base role, the dialog warns: “Mintlify is your knowledge base integration. That role is left unassigned until you pick another.”
  3. Select Disconnect to confirm, or Keep connected to cancel.

After disconnecting, the Mintlify card disappears from Integrations and can't be connected again. The Pageloop GitHub App stays installed on GitHub; remove it in GitHub's installed apps settings if nothing else uses it. To keep Pageloop working on the same docs, connect the GitHub integration and choose the repository as its knowledge base repository.

Troubleshooting

Message or symptomWhat to check
“Please select a repository”Choose a repository before saving.
“Selected repository is not accessible”The repository was not granted to the Pageloop app when it was installed. Grant it on GitHub, or connect the GitHub integration, which reads the current list each time.
Needs reconnecting, with “Mintlify needs to be reconnected. Pageloop lost access, so it is paused until you reconnect it.”Pageloop stopped syncing after repeated failures. Disconnect Mintlify from the ... menu and connect the GitHub integration with the same repository instead.
“Could not disconnect Mintlify”Try again in a moment.