Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .vale/styles/Mintlify/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ match: $sentence
indicators:
- ":"
exceptions:
- Autopilot
- Azure
- Claude Code
- CLAUDE.md
Expand Down
2 changes: 2 additions & 0 deletions automations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Automations run the agent automatically on a schedule, in response to pushes to

When an automation runs, the agent reads your project content and any connected repositories, then follows the prompt to make updates.

To have an agent decide what to update without writing prompts or configuring triggers, use [Autopilot](/autopilot).

<Tip>
Use automations that run on a schedule for recurring tasks, like publishing changelogs or improving content based on users' conversations with the [assistant](/assistant).

Expand Down
116 changes: 116 additions & 0 deletions autopilot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
title: "Keep documentation up-to-date with Autopilot"
sidebarTitle: "Autopilot"
description: "Autopilot is an early access agent that keeps content accurate and up-to-date by opening pull requests when merged code changes and performing ongoing maintenance."
keywords: ["self-updating docs", "docs maintenance"]
---

<Info>
Autopilot is in early access and subject to change.

Autopilot requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=autopilot).
</Info>

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). 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 during early access.
- The [Mintlify GitHub App](/deploy/github) 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. Click **Enable Autopilot**.

When you first enable Autopilot, it builds context about your documentation, which typically takes a few minutes. When this initial context check finishes, you can chat with Autopilot.

## 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.

Check warning on line 50 in autopilot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

autopilot.mdx#L50

In general, use active voice instead of passive voice ('is installed').

### 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](/automations/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.

## How Autopilot opens pull requests

Autopilot 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.

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.

### 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.

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 open pull requests appear under **Suggestions** on the [Autopilot](https://app.mintlify.com/products/autopilot) page of your dashboard.

Click a suggestion to open it. 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

Click [Chat with Autopilot](https://app.mintlify.com/products/autopilot/new) to start a conversation with Autopilot.

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.

Chats require the editor or admin [role](/dashboard/roles). You cannot start a new chat while Autopilot is paused.

Check warning on line 97 in autopilot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

autopilot.mdx#L97

In general, use active voice instead of passive voice ('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.

Check warning on line 103 in autopilot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

autopilot.mdx#L103

In general, use active voice instead of passive voice ('was paused').

### 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](/credits#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](/credits) for more information.
6 changes: 6 additions & 0 deletions credits.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
| Narration generates audio for a page | 50 |
| Automation updates your docs | 250 |
| Automation finds nothing to update | 0 |
| Autopilot opens or updates a pull request | 250 |
| Autopilot finds nothing to update | 0 |

The price is the same regardless of how much content the agent reads, how many passes it takes, or how long the action runs.

Expand All @@ -48,7 +50,7 @@

[Narration](/assistant/narration) costs 50 credits when Mintlify successfully generates audio for a page. The first reader to listen triggers generation on demand. After generation finishes, Mintlify caches the audio and timing data, so subsequent plays by any reader consume no additional credits.

When you change a page's published narratable content, the next listener generates an updated recording for another 50 credits. Failed generations cost nothing. If multiple readers start narration before the first generation finishes and is cached, each request may generate audio and consume 50 credits.

Check warning on line 53 in credits.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

credits.mdx#L53

In general, use active voice instead of passive voice ('is cached').

### Automation updates

Expand All @@ -56,6 +58,10 @@

A run that reviews your repository and finds nothing to update costs nothing. Runs that fail also cost nothing.

### Autopilot updates

Each [Autopilot](/autopilot) run that opens or updates a pull request costs 250 credits. A run that changes several pages is still one update. Runs that don't open or update a pull request cost nothing.

### Editor agent and Slack agent

Pro and Enterprise plans include the [editor agent](/editor/agent) and the [agent in Slack](/agent/slack). Using them doesn't consume credits.
Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@
"deploy/gitlab-self-hosted"
]
},
"autopilot",
"agent/customize",
"agent/effective-prompts",
"agent/use-cases"
Expand Down
Loading