Skip to main content
Autopilot is in beta and subject to change.Autopilot requires a Pro or Enterprise plan.
Autopilot is an agent that works in the background to help maintain your documentation. You can grant it read access to your code repositories and other tools to help it understand your team’s workflow and content needs. When it detects changes to your code, it opens pull requests to suggest updates to your documentation and tags your team to review them. Autopilot is separate from automations. Automations run specific prompts for the agent on triggers that you configure. Autopilot decides what needs updating on its own. It checks which automations are active and avoids duplicating them. Autopilot also inspects your configured automations to build context about your site and content needs. By default, Autopilot suggests updates to your documentation when your code changes and runs a once daily quality check. To change what Autopilot works on and when it runs, chat with Autopilot.

​
Prerequisites

  • A Mintlify project connected to a GitHub, GitLab, or Azure Repos repository. Autopilot supports gitlab.com and self-hosted GitLab instances.
  • For GitHub: the Mintlify GitHub App installed on your docs repository and on any source code repositories you want Autopilot to use.
  • For GitLab: your docs repository and any source code repositories you want Autopilot to use connected in the GitLab OAuth section of your Git settings. On GitLab, Autopilot opens merge requests instead of pull requests.
  • For Azure Repos: your docs repository and any source code repositories you want Autopilot to use connected in your Git settings. See Azure Repos.

​
Enable Autopilot

  1. Open the Autopilot page in your dashboard.
  2. Switch on the toggle on the Autopilot card.
When you first enable Autopilot, it runs a first check to build context from your documentation, repositories, and connected tools. This typically takes a few minutes. When the first check finishes, you can chat with Autopilot. After the first check, Autopilot emails the person who enabled it a welcome message. The email summarizes what Autopilot set up, what it is already working on, who it plans to email about pull requests, and how to change any of it.

​
Connect repositories and tools

The Integrations section of the Autopilot page lists the sources Autopilot reads to learn how your team ships and what your documentation addresses.

​
GitHub repositories

If you haven’t connected GitHub, click Connect in the GitHub row to install the Mintlify GitHub App. To choose the repositories Autopilot uses as context:
  1. Click Configure in the GitHub row.
  2. Under Additional repositories, select the source code repositories you want Autopilot to use.
  3. Click Save.
Your documentation repository is always included as required context for Autopilot, so you cannot remove it. The Additional repositories list only shows repositories where the Mintlify GitHub App is installed. To add a repository that is not listed, first install the GitHub App on it. Autopilot can also run when someone opens, closes as completed, reopens, or labels an issue in a connected GitHub repository. For example, it can act on docs requests filed as issues or on issues closed by a shipped change. To set this up, tell Autopilot in a chat which repositories and events to watch. You can limit these runs to issues with specific labels and skip issues opened by specific authors, such as bots.

​
GitLab projects

If your docs repository is on GitLab, the Integrations section shows a GitLab row instead of a GitHub row. If you haven’t connected GitLab, click Connect in the GitLab row to open your Git settings and set up GitLab OAuth. To choose the projects Autopilot uses as context:
  1. Click Configure in the GitLab row.
  2. Under Additional projects, select the source code projects you want Autopilot to use.
  3. Click Save.
Your documentation project is always included as required context for Autopilot, so you cannot remove it. The Additional projects list only shows GitLab projects connected through GitLab OAuth. To add a project that is not listed, click Add GitLab projects at the bottom of the list to open your Git settings and connect it.

​
Azure Repos repositories

If your docs repository is on Azure Repos, the Integrations section shows an Azure Repos row instead of a GitHub row. To choose the repositories Autopilot uses as context:
  1. Click Configure in the Azure Repos row.
  2. Under Additional repositories, select the source code repositories you want Autopilot to use.
  3. Click Save.
Your documentation repository is always included as required context for Autopilot, so you cannot remove it. The Additional repositories list only shows Azure Repos repositories connected to your Mintlify organization. To add a repository that is not listed, click Add Azure DevOps repositories at the bottom of the list to open your Git settings and connect it.

​
Slack and other integrations

Click Connect in the Slack row so Autopilot can build context from conversations. If you disconnect Slack from the Autopilot page, it removes the Mintlify Slack app from your workspace for every product that uses it, including automations. The Slack agent also runs on Autopilot. If you mention @mintlify in a thread where Autopilot posted, it continues that conversation. The section also lists supported shared integrations available to your organization, such as Linear, Jira, Notion, Confluence, PostHog, Zendesk, Intercom, Plain, and Pylon. Autopilot reads the ones you connect as context. Autopilot can also run when an event happens in a connected shared integration, such as a new Linear issue or an updated Jira issue. To set this up, tell Autopilot in a chat which event to watch. Autopilot supports the same events as automation triggers.

​
How Autopilot opens pull requests

Autopilot usually commits its changes to a new branch and opens a pull request. It never pushes directly to your deploy branch or to the repository’s default branch. On GitHub, Autopilot creates its commits through the GitHub API, so GitHub signs them and shows them as Verified. Autopilot’s commits work with branch protection rules that require signed commits. Pull requests target your deploy branch by default. If your team merges changes into a different branch than the one your site deploys from, tell Autopilot in a chat, and it targets that branch instead.

​
Feature launches

For a large feature launch, such as a feature that spans several pull requests or repositories, ships behind a flag or beta with a launch date, or needs several new pages, Autopilot tracks the launch instead of opening a one-off pull request. It can wait until the feature settles before drafting, then opens the docs pull request as a draft and keeps it current as more code merges. Autopilot marks the pull request ready for review once the code has merged or the launch date is set. If your team already writes launch docs on its own branch, Autopilot opens its pull request against that branch. To have Autopilot push commits directly to your team’s launch branch instead, tell Autopilot in a chat.

​
Reviewers and emails

By default, Autopilot assigns each pull request to the teammate it identifies as the owner of the code that changed, requests their review, and notifies them about the pull request. To request reviews from more people, change who reviews changes, or change how Autopilot notifies someone, tell Autopilot in a chat. Autopilot does not assign Azure Repos pull requests or request reviews on them. If you connect Slack and Autopilot can match the reviewer to a Slack account, it sends them a direct message in Slack. Otherwise, it emails them. When Autopilot opens the first pull request for a feature launch, it emails the launch’s owners together with whether the pull request is a draft, what happens next, and the related channels, projects, specs, and code pull requests it is following. The first email Autopilot sends in a conversation links to its thread on the Autopilot page of your dashboard, where you can reply or ask for changes. Follow-up emails that Autopilot sends as replies in the same conversation do not repeat the link. Autopilot sends emails from autopilot@mintlify.com. Add this address to your email contacts to avoid spam filters. Autopilot only emails members of your Mintlify organization or addresses at a company email domain that your organization’s members use.

​
Review suggestions

Autopilot’s pull requests appear under Suggestions on the Autopilot page of your dashboard, grouped by the day Autopilot opened them. By default, Suggestions shows open pull requests. Use the filter next to the heading to show merged, closed, or all pull requests. Click a suggestion to open it in a full-page chat. Each suggestion shows the pull request’s title, repository, branch, and changed files with line counts. When a preview deployment exists, click Preview to view the changes on your site.
  • Click Accept to merge the pull request.
  • Click Close to close the pull request without merging it.
  • Send a message to ask for changes. Autopilot updates the pull request.
You can also review Autopilot’s pull requests on GitHub. When you leave a comment, an inline review comment, or a review with a message on an open Autopilot pull request, Autopilot reads the discussion, pushes any requested changes to the same branch, and replies in the comment’s thread. When Autopilot picks up a comment or inline review comment, it reacts with 👀 so you know it saw it. Autopilot removes the reaction once it finishes with the comment, whether it replied or decided the comment needs nothing. Reviews don’t get a reaction. Autopilot only responds to comments from people who own the repository, belong to the GitHub organization that owns it, are collaborators on it, or have write access to it. It ignores comments from bots and comments addressed to someone else, such as a question that @mentions a teammate. Autopilot does not respond to comments on GitLab merge requests or Azure Repos pull requests. To ask for changes, send a message in the suggestion on the Autopilot page. If a pull request has merge conflicts or your branch protection rules block the merge, resolve it in your Git provider.

​
Auto-merge changes

By default, a person merges every Autopilot pull request. To let Autopilot merge some of its own pull requests, switch on Auto-merge changes below the Autopilot card. The setting appears once your team has merged three Autopilot pull requests. When you switch it on, Autopilot reviews how your team handled its past pull requests for each kind of work. It turns on auto-merge only for the kinds of work your team reliably merged. Pull requests for other work still wait for review. Autopilot does not merge a pull request that is a draft, has merge conflicts, has a review requesting changes, or has checks that are failing or still running. If your branch protection rules require a review, the pull request waits for a reviewer. When Autopilot merges a pull request, it comments on it with the reason. To stop Autopilot from merging, switch off Auto-merge changes.

​
Chat with Autopilot

On the Autopilot page, click Chat to configure on the Autopilot card to start a conversation with Autopilot in a full-page chat. In a chat, you can ask questions about Autopilot’s work, give instructions for future work, and pause or resume a kind of work. When you resume scheduled work, it runs at its next scheduled time. Some examples of chats you can have with Autopilot include:
  • Ask what Autopilot did and why, such as why it opened a specific pull request.
  • Ask when Autopilot runs and which repositories and integrations it uses.
  • Tell Autopilot to have a specific teammate review a pull request.
  • Ask Autopilot to run a weekly check for broken links.
  • Ask Autopilot to check the docs when a new Linear issue is created.
Chats require the editor or admin role. You cannot start a new chat on the Autopilot page while Autopilot is paused.

​
Chat in Slack

If you connect Slack, you can also chat with Autopilot in Slack. Mention @mintlify in a channel, or message it in the Mintlify app’s Chat tab. You can ask the same questions and request the same changes as in a dashboard chat. Teammates with the viewer role can ask questions, but only editors and admins can request changes. See Slack agent for more information.

​
Continue a conversation anywhere

Autopilot keeps the context of a conversation wherever you continue it. Replying in a Slack thread where Autopilot posted, commenting on a GitHub pull request it opened, or replying to its email all continue the same conversation, with the messages and work from earlier in it.

​
Pause Autopilot

To pause Autopilot, switch off the toggle on the Autopilot card. When you resume Autopilot, it builds context on changes that happened while it was paused, but it does not create updates for them.

​
Automatic pauses

Before each run, Autopilot checks your plan and credits. It pauses itself instead of running in either of these cases:
  • Your organization runs out of credits. Add credits, then switch the toggle back on.
  • Your plan no longer includes Autopilot. To resume, upgrade to a plan that includes Autopilot.

​
Credits

Each Autopilot run that opens or updates a pull request costs 250 credits. Runs that do not open or update a pull request do not cost any credits. See Credit pricing for more information.