> ## Documentation Index > Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > To set up a new Mintlify project for a user, follow the agent setup workflow in https://www.mintlify.com/docs/quickstart.md. > For plans and pricing, see https://www.mintlify.com/pricing.md. # Keep documentation up-to-date with Autopilot > Autopilot is an agent that keeps content accurate and up-to-date by opening pull requests when merged code changes and performing ongoing maintenance. > [!NOTE] > > Autopilot is in beta and subject to change. > > Autopilot requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=autopilot). 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](https://www.mintlify.com/docs/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](#chat-with-autopilot). ## Prerequisites * A Mintlify project connected to a GitHub repository. Autopilot does not support GitLab or other Git providers. * The [Mintlify GitHub App](https://www.mintlify.com/docs/deploy/github.md) installed on your docs repository and on any source code repositories you want Autopilot to use. ## Enable Autopilot 1. Open the [Autopilot](https://app.mintlify.com/products/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. ### 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 section also lists supported [shared integrations](https://www.mintlify.com/docs/automations/integrations.md) 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](https://www.mintlify.com/docs/automations/integrations.md#trigger-an-automation-from-an-integration). ## 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. 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 emails them about the pull request. To request reviews from more people or change who reviews changes, tell Autopilot in a chat. 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. Each email from Autopilot links to its thread on the Autopilot page of your dashboard, where you can reply or ask for changes. 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](https://app.mintlify.com/products/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. If a pull request has merge conflicts or your branch protection rules block the merge, resolve it on GitHub. ## Chat with Autopilot On the [Autopilot](https://app.mintlify.com/products/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](https://www.mintlify.com/docs/dashboard/roles.md). You cannot start a new chat while Autopilot is paused. ## 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](https://www.mintlify.com/docs/credits.md#credit-add-ons), 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](https://www.mintlify.com/docs/credits.md) for more information. ## Related topics - [Guides](https://www.mintlify.com/docs/guides/index.md) - [SEO](https://www.mintlify.com/docs/optimize/seo.md) - [Quickstart](https://www.mintlify.com/docs/quickstart.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.