From b36decb2c2538c0be4469351c89ddc0ac96b2c4f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 14:33:40 -0700 Subject: [PATCH 1/9] docs: add Autopilot page from #7868 (English only) Translations will run after merge. Co-Authored-By: Claude Opus 5.5 (1M context) --- agent/autopilot.mdx | 124 ++++++++++++++++++++++++++++++++++++++++++++ docs.json | 1 + 2 files changed, 125 insertions(+) create mode 100644 agent/autopilot.mdx diff --git a/agent/autopilot.mdx b/agent/autopilot.mdx new file mode 100644 index 0000000000..c3e617f38e --- /dev/null +++ b/agent/autopilot.mdx @@ -0,0 +1,124 @@ +--- +title: "Keep your docs current with Autopilot" +sidebarTitle: "Autopilot" +description: "Autopilot is an early access agent that keeps your docs current by opening pull requests when merged code changes and by fixing typos and broken links." +keywords: ["Autopilot", "self-updating docs", "docs maintenance", "pull requests", "suggestions", "reviewer", "early access"] +--- + + + Autopilot is in early access. If **Autopilot** does not appear in your dashboard sidebar, it is not available for your project yet. + + +Autopilot is an agent that keeps your documentation current in the background. It watches merged code and your connected tools, and opens pull requests when your docs fall behind. Nothing changes on your site until someone on your team merges one of its pull requests. + +Autopilot is separate from [automations](/automations). Automations run prompts that you write on triggers that you configure. Autopilot decides what needs updating on its own. + +## What Autopilot does + +- **Updates docs from code changes.** When code merges in a connected repository, Autopilot checks whether your docs need to change and opens a pull request if they do. +- **Fixes typos and broken links.** Autopilot also runs maintenance checks on your docs. + +Autopilot works as changes land and once a day. + +## Prerequisites + +- A Mintlify project connected to a GitHub repository. +- The [Mintlify GitHub App](/deploy/github) installed on your docs repository and on any source code repositories you want Autopilot to use. +- A plan that includes Autopilot. + +If your plan doesn't include Autopilot, the Autopilot page shows an **Unlock Autopilot** prompt instead of its settings. Click **Upgrade to use Autopilot** to upgrade. Until you do, **Chat with Autopilot** is hidden from the Autopilot sidebar, and suggestions and recent chats don't load. During a product trial, the trial banner and the sidebar trial badge also appear for Autopilot. + +## Enable Autopilot + +1. Open the [Autopilot](https://app.mintlify.com/products/autopilot) page in your dashboard. +2. Click **Enable Autopilot**. + +Autopilot starts with a first check of your docs. Chat with Autopilot becomes available when this check finishes, usually within a few minutes. If the first check does not finish, Autopilot tries again the next day. + +## 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 docs should cover. + +### GitHub repositories + +If GitHub is not connected yet, 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**. + +The dialog lists your docs repository under **Required repositories**. Autopilot always uses it, 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, install the GitHub App on it first. + +### Slack and other integrations + +Click **Connect** in the **Slack** row so Autopilot can read team conversations about launches and documentation requests. Disconnecting Slack from the Autopilot page 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 in your docs repository 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 docs 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 + +Autopilot picks one teammate for each pull request, usually the person who owns that part of your docs. That person is the pull request's assignee and its requested reviewer, and the one Autopilot emails about it. To change who reviews a kind of change, tell Autopilot in a chat. + +Autopilot sends emails from `autopilot@mintlify.com`. Each email ends with a footer saying that an AI agent wrote it. + +Autopilot only emails members of your Mintlify organization or addresses at a company email domain that your organization's members use. Public email domains, such as `gmail.com`, never count as company domains. + +## Review suggestions + +Autopilot's open pull requests appear under **Suggestions** in the Autopilot sidebar. The **Autopilot** item in your dashboard sidebar shows how many are open. + +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 **Talk to Autopilot** on the Autopilot page, or **Chat with Autopilot** in the Autopilot sidebar. Your recent chats appear under **Recents**. + +In a chat, you can: + +- 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. +- Give instructions for future work, such as who should review a kind of change or which branch to target. +- Pause or resume a kind of work. When you resume scheduled work, it runs at its next scheduled time. + +Chats require the editor or admin [role](/dashboard/roles). You cannot start a new chat while Autopilot is paused. + +When Autopilot is enabled for your project, you can also ask the [editor agent](/editor/agent) about Autopilot's pull requests, schedule, and setup. + +## Pause Autopilot + +Use the toggle on the **Autopilot** card to pause or resume Autopilot. The card shows **Paused** or **Enabled**. + +While Autopilot is paused, it does not start new work. Work that comes in while it is paused waits until you turn Autopilot back on. + +### Automatic pauses + +Before Autopilot runs, Mintlify checks your plan and credits. Autopilot pauses itself instead of running in either of these cases: + +- **Your organization runs out of credits.** The Autopilot page shows **Autopilot paused because you ran out of credits**. [Add credits](/credits#credit-add-ons), then use the toggle to turn Autopilot back on. Organizations that [bring their own model](/ai/bring-your-own-model) skip this check. +- **Your plan no longer includes Autopilot.** The Autopilot page shows the **Unlock Autopilot** prompt. To resume, upgrade to a plan that includes Autopilot. + +When Autopilot pauses itself, Mintlify emails the person who first enabled Autopilot, if they are still in your organization. Otherwise, Mintlify emails your organization's [admin contact emails](/dashboard/notifications#organization-contacts). Pausing Autopilot yourself does not send an email. + +Work that comes in during an automatic pause runs when Autopilot resumes. + +## Credits + +Each Autopilot run that opens or updates a pull request costs 250 credits, the same as an [automation update](/credits#automation-updates). Runs that do not open or update a pull request cost nothing. + +Chatting with Autopilot uses the editor agent, which does not consume credits. See [Credit pricing](/credits) for how your organization's balance works. diff --git a/docs.json b/docs.json index 76b5e83176..505525fc12 100644 --- a/docs.json +++ b/docs.json @@ -275,6 +275,7 @@ "deploy/gitlab-self-hosted" ] }, + "agent/autopilot", "agent/customize", "agent/effective-prompts", "agent/use-cases" From 213e31948167988a49a315d302cff9422a1c6d38 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 14:35:59 -0700 Subject: [PATCH 2/9] docs: verify Autopilot page against server and dashboard code Add Pro/Enterprise gating, GitHub-only prerequisite, chat-only configuration, turn-off wording, automation overlap, Autopilot credits on the credits page, an automations cross-link, and a /autopilot redirect for the dashboard's learn-more link. Co-Authored-By: Claude Opus 5.5 (1M context) --- agent/autopilot.mdx | 33 +++++++++++++++++---------------- automations/index.mdx | 2 ++ credits.mdx | 6 ++++++ redirects.json | 4 ++++ 4 files changed, 29 insertions(+), 16 deletions(-) diff --git a/agent/autopilot.mdx b/agent/autopilot.mdx index c3e617f38e..fc2ac66175 100644 --- a/agent/autopilot.mdx +++ b/agent/autopilot.mdx @@ -6,27 +6,26 @@ keywords: ["Autopilot", "self-updating docs", "docs maintenance", "pull requests --- - Autopilot is in early access. If **Autopilot** does not appear in your dashboard sidebar, it is not available for your project yet. + Autopilot is in early access and requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=autopilot). Autopilot is an agent that keeps your documentation current in the background. It watches merged code and your connected tools, and opens pull requests when your docs fall behind. Nothing changes on your site until someone on your team merges one of its pull requests. -Autopilot is separate from [automations](/automations). Automations run prompts that you write on triggers that you configure. Autopilot decides what needs updating on its own. +Autopilot is separate from [automations](/automations). Automations run prompts that you write on triggers that you configure. Autopilot decides what needs updating on its own. It checks which automations are active and leaves their work to them. ## What Autopilot does -- **Updates docs from code changes.** When code merges in a connected repository, Autopilot checks whether your docs need to change and opens a pull request if they do. -- **Fixes typos and broken links.** Autopilot also runs maintenance checks on your docs. +- Updates your docs from code changes. When code merges in a connected repository, Autopilot checks whether your docs need to change and opens a pull request if they do. +- Fixes typos and broken links in your docs. -Autopilot works as changes land and once a day. +Autopilot works as changes land and once a day. There are no settings for schedules or scope. To change what Autopilot works on, [chat with Autopilot](#chat-with-autopilot). ## Prerequisites -- A Mintlify project connected to a GitHub repository. +- A Mintlify project connected to a GitHub repository. Autopilot does not support GitLab or other Git providers. - The [Mintlify GitHub App](/deploy/github) installed on your docs repository and on any source code repositories you want Autopilot to use. -- A plan that includes Autopilot. -If your plan doesn't include Autopilot, the Autopilot page shows an **Unlock Autopilot** prompt instead of its settings. Click **Upgrade to use Autopilot** to upgrade. Until you do, **Chat with Autopilot** is hidden from the Autopilot sidebar, and suggestions and recent chats don't load. During a product trial, the trial banner and the sidebar trial badge also appear for Autopilot. +If your plan doesn't include Autopilot, the Autopilot page shows an **Unlock Autopilot** prompt instead of its settings. Click **Upgrade to use Autopilot** to upgrade. ## Enable Autopilot @@ -55,6 +54,8 @@ The **Additional repositories** list only shows repositories where the Mintlify ### Slack and other integrations +{/* TODO: Confirm which integrations are available on the Pro plan. Pro may only get GitHub and Slack. */} + Click **Connect** in the **Slack** row so Autopilot can read team conversations about launches and documentation requests. Disconnecting Slack from the Autopilot page 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. @@ -96,24 +97,24 @@ In a chat, you can: - Give instructions for future work, such as who should review a kind of change or which branch to target. - Pause or resume a kind of work. When you resume scheduled work, it runs at its next scheduled time. -Chats require the editor or admin [role](/dashboard/roles). You cannot start a new chat while Autopilot is paused. +Chats require the editor or admin [role](/dashboard/roles). You cannot start a new chat while Autopilot is turned off. When Autopilot is enabled for your project, you can also ask the [editor agent](/editor/agent) about Autopilot's pull requests, schedule, and setup. -## Pause Autopilot +## Turn off Autopilot -Use the toggle on the **Autopilot** card to pause or resume Autopilot. The card shows **Paused** or **Enabled**. +To turn off Autopilot, switch off the toggle on the **Autopilot** card. The card shows **Paused** while Autopilot is off and **Enabled** while it is on. -While Autopilot is paused, it does not start new work. Work that comes in while it is paused waits until you turn Autopilot back on. +While Autopilot is off, it does not start new work. Work that comes in while it is off waits until you turn Autopilot back on. ### Automatic pauses -Before Autopilot runs, Mintlify checks your plan and credits. Autopilot pauses itself instead of running in either of these cases: +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.** The Autopilot page shows **Autopilot paused because you ran out of credits**. [Add credits](/credits#credit-add-ons), then use the toggle to turn Autopilot back on. Organizations that [bring their own model](/ai/bring-your-own-model) skip this check. -- **Your plan no longer includes Autopilot.** The Autopilot page shows the **Unlock Autopilot** prompt. To resume, upgrade to a plan that includes Autopilot. +- Your organization runs out of credits. The Autopilot page shows **Autopilot paused because you ran out of credits**. [Add credits](/credits#credit-add-ons), then switch the toggle back on. Organizations that [bring their own model](/ai/bring-your-own-model) skip this check. +- Your plan no longer includes Autopilot. The Autopilot page shows the **Unlock Autopilot** prompt. To resume, upgrade to a plan that includes Autopilot. -When Autopilot pauses itself, Mintlify emails the person who first enabled Autopilot, if they are still in your organization. Otherwise, Mintlify emails your organization's [admin contact emails](/dashboard/notifications#organization-contacts). Pausing Autopilot yourself does not send an email. +When Autopilot pauses itself, Mintlify emails the person who enabled Autopilot, if they are still in your organization. Otherwise, Mintlify emails your organization's [admin contact emails](/dashboard/notifications#organization-contacts). Turning off Autopilot yourself does not send an email. Work that comes in during an automatic pause runs when Autopilot resumes. diff --git a/automations/index.mdx b/automations/index.mdx index 7949516a39..84d0e2840b 100644 --- a/automations/index.mdx +++ b/automations/index.mdx @@ -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](/agent/autopilot). + Use automations that run on a schedule for recurring tasks, like publishing changelogs or improving content based on users' conversations with the [assistant](/assistant). diff --git a/credits.mdx b/credits.mdx index c5bbebae25..7a9c4a3a3c 100644 --- a/credits.mdx +++ b/credits.mdx @@ -33,6 +33,8 @@ Every AI action has a fixed credit price. Actions that produce nothing cost noth | 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. @@ -56,6 +58,10 @@ An update is a run that changes your docs. Depending on the automation's [update A run that reviews your repository and finds nothing to update costs nothing. Runs that fail also cost nothing. +### Autopilot updates + +Each [Autopilot](/agent/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. diff --git a/redirects.json b/redirects.json index f72654501e..2d88ff0ebb 100644 --- a/redirects.json +++ b/redirects.json @@ -1143,6 +1143,10 @@ "source": "/zh/create/broken-links", "destination": "/zh/create/redirects" }, + { + "source": "/autopilot", + "destination": "/agent/autopilot" + }, { "source": "/ai/autopilot", "destination": "/automations/index" From 65bc48031fa624d16e7ac2ea818565b7fa8bdcaf Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 14:35:59 -0700 Subject: [PATCH 3/9] vale: treat Autopilot as a proper noun in headings Co-Authored-By: Claude Opus 5.5 (1M context) --- .vale/styles/Mintlify/Headings.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.vale/styles/Mintlify/Headings.yml b/.vale/styles/Mintlify/Headings.yml index 47583b69bb..96f42c8bea 100644 --- a/.vale/styles/Mintlify/Headings.yml +++ b/.vale/styles/Mintlify/Headings.yml @@ -6,6 +6,7 @@ match: $sentence indicators: - ":" exceptions: + - Autopilot - Azure - Claude Code - CLAUDE.md From acaf8d1152278a4133167b02d2fa471d7eb44bf3 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 14:37:46 -0700 Subject: [PATCH 4/9] docs: move Autopilot page to /autopilot Matches the dashboard's learn-more link, so no redirect is needed. Co-Authored-By: Claude Opus 5.5 (1M context) --- automations/index.mdx | 2 +- agent/autopilot.mdx => autopilot.mdx | 0 credits.mdx | 2 +- docs.json | 2 +- redirects.json | 4 ---- 5 files changed, 3 insertions(+), 7 deletions(-) rename agent/autopilot.mdx => autopilot.mdx (100%) diff --git a/automations/index.mdx b/automations/index.mdx index 84d0e2840b..0ec14784c7 100644 --- a/automations/index.mdx +++ b/automations/index.mdx @@ -14,7 +14,7 @@ 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](/agent/autopilot). +To have an agent decide what to update without writing prompts or configuring triggers, use [Autopilot](/autopilot). Use automations that run on a schedule for recurring tasks, like publishing changelogs or improving content based on users' conversations with the [assistant](/assistant). diff --git a/agent/autopilot.mdx b/autopilot.mdx similarity index 100% rename from agent/autopilot.mdx rename to autopilot.mdx diff --git a/credits.mdx b/credits.mdx index 7a9c4a3a3c..3f6871eccd 100644 --- a/credits.mdx +++ b/credits.mdx @@ -60,7 +60,7 @@ A run that reviews your repository and finds nothing to update costs nothing. Ru ### Autopilot updates -Each [Autopilot](/agent/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. +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 diff --git a/docs.json b/docs.json index 505525fc12..0ef36f8f15 100644 --- a/docs.json +++ b/docs.json @@ -275,7 +275,7 @@ "deploy/gitlab-self-hosted" ] }, - "agent/autopilot", + "autopilot", "agent/customize", "agent/effective-prompts", "agent/use-cases" diff --git a/redirects.json b/redirects.json index 2d88ff0ebb..f72654501e 100644 --- a/redirects.json +++ b/redirects.json @@ -1143,10 +1143,6 @@ "source": "/zh/create/broken-links", "destination": "/zh/create/redirects" }, - { - "source": "/autopilot", - "destination": "/agent/autopilot" - }, { "source": "/ai/autopilot", "destination": "/automations/index" From 9c440c516677d83bd6a57958400d65d1aaa19c71 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 14:56:36 -0700 Subject: [PATCH 5/9] docs: apply Patrick's Autopilot review Multiple reviewers via chat, learns from past automations, and the same integrations on Pro and Enterprise. Co-Authored-By: Claude Opus 5.5 (1M context) --- autopilot.mdx | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/autopilot.mdx b/autopilot.mdx index fc2ac66175..8c0549e759 100644 --- a/autopilot.mdx +++ b/autopilot.mdx @@ -11,7 +11,7 @@ keywords: ["Autopilot", "self-updating docs", "docs maintenance", "pull requests Autopilot is an agent that keeps your documentation current in the background. It watches merged code and your connected tools, and opens pull requests when your docs fall behind. Nothing changes on your site until someone on your team merges one of its pull requests. -Autopilot is separate from [automations](/automations). Automations run prompts that you write on triggers that you configure. Autopilot decides what needs updating on its own. It checks which automations are active and leaves their work to them. +Autopilot is separate from [automations](/automations). Automations run prompts that you write on triggers that you configure. Autopilot decides what needs updating on its own. It checks which automations are active and leaves their work to them. It also looks at automations you used to run to learn about your setup. ## What Autopilot does @@ -54,8 +54,6 @@ The **Additional repositories** list only shows repositories where the Mintlify ### Slack and other integrations -{/* TODO: Confirm which integrations are available on the Pro plan. Pro may only get GitHub and Slack. */} - Click **Connect** in the **Slack** row so Autopilot can read team conversations about launches and documentation requests. Disconnecting Slack from the Autopilot page 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. @@ -68,7 +66,7 @@ Pull requests target your deploy branch by default. If your team merges docs cha ### Reviewers and emails -Autopilot picks one teammate for each pull request, usually the person who owns that part of your docs. That person is the pull request's assignee and its requested reviewer, and the one Autopilot emails about it. To change who reviews a kind of change, tell Autopilot in a chat. +By default, Autopilot assigns each pull request to the teammate who owns that part of your docs, requests their review, and emails them about it. To request reviews from more people or change who reviews a kind of change, tell Autopilot in a chat. Autopilot sends emails from `autopilot@mintlify.com`. Each email ends with a footer saying that an AI agent wrote it. From cf7339f6beaebe2a1f51f884a5fe2171628c7746 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 15:34:08 -0700 Subject: [PATCH 6/9] docs: use Chat with Autopilot label for the Autopilot page button Co-Authored-By: Claude Opus 5.5 (1M context) --- autopilot.mdx | 81 ++++++++++++++++++++++++--------------------------- 1 file changed, 38 insertions(+), 43 deletions(-) diff --git a/autopilot.mdx b/autopilot.mdx index 8c0549e759..c39dc59e45 100644 --- a/autopilot.mdx +++ b/autopilot.mdx @@ -1,46 +1,43 @@ --- -title: "Keep your docs current with Autopilot" +title: "Keep documentation up-to-date with Autopilot" sidebarTitle: "Autopilot" -description: "Autopilot is an early access agent that keeps your docs current by opening pull requests when merged code changes and by fixing typos and broken links." -keywords: ["Autopilot", "self-updating docs", "docs maintenance", "pull requests", "suggestions", "reviewer", "early access"] +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"] --- - Autopilot is in early access and requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=autopilot). + Autopilot is in early access and subject to change. + + Autopilot requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=autopilot). -Autopilot is an agent that keeps your documentation current in the background. It watches merged code and your connected tools, and opens pull requests when your docs fall behind. Nothing changes on your site until someone on your team merges one of its pull requests. +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 prompts that you write on triggers that you configure. Autopilot decides what needs updating on its own. It checks which automations are active and leaves their work to them. It also looks at automations you used to run to learn about your setup. +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 run to build context about your site and content needs. -## What Autopilot does +By default, Autopilot suggests updates to your documentation when your code changes and runs a once daily quality check. -- Updates your docs from code changes. When code merges in a connected repository, Autopilot checks whether your docs need to change and opens a pull request if they do. -- Fixes typos and broken links in your docs. - -Autopilot works as changes land and once a day. There are no settings for schedules or scope. To change what Autopilot works on, [chat with Autopilot](#chat-with-autopilot). +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. +- 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. -If your plan doesn't include Autopilot, the Autopilot page shows an **Unlock Autopilot** prompt instead of its settings. Click **Upgrade to use Autopilot** to upgrade. - ## Enable Autopilot 1. Open the [Autopilot](https://app.mintlify.com/products/autopilot) page in your dashboard. 2. Click **Enable Autopilot**. -Autopilot starts with a first check of your docs. Chat with Autopilot becomes available when this check finishes, usually within a few minutes. If the first check does not finish, Autopilot tries again the next day. +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 docs should cover. +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 GitHub is not connected yet, click **Connect** in the **GitHub** row to install the Mintlify GitHub App. +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: @@ -48,33 +45,33 @@ To choose the repositories Autopilot uses as context: 2. Under **Additional repositories**, select the source code repositories you want Autopilot to use. 3. Click **Save**. -The dialog lists your docs repository under **Required repositories**. Autopilot always uses it, so you cannot remove it. +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, install the GitHub App on it first. +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 read team conversations about launches and documentation requests. Disconnecting Slack from the Autopilot page removes the Mintlify Slack app from your workspace for every product that uses it, including automations. +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 in your docs repository and opens a pull request. It never pushes directly to your deploy branch or to the repository's default branch. +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 docs changes into a different branch than the one your site deploys from, tell Autopilot in a chat, and it targets that branch instead. +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 who owns that part of your docs, requests their review, and emails them about it. To request reviews from more people or change who reviews a kind of change, tell Autopilot in a chat. +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`. Each email ends with a footer saying that an AI agent wrote it. +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. Public email domains, such as `gmail.com`, never count as company domains. +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** in the Autopilot sidebar. The **Autopilot** item in your dashboard sidebar shows how many are open. +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. @@ -86,38 +83,36 @@ If a pull request has merge conflicts or your branch protection rules block the ## Chat with Autopilot -Click **Talk to Autopilot** on the Autopilot page, or **Chat with Autopilot** in the Autopilot sidebar. Your recent chats appear under **Recents**. +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. -In a chat, you can: +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. -- Give instructions for future work, such as who should review a kind of change or which branch to target. -- Pause or resume a kind of work. When you resume scheduled work, it runs at its next scheduled time. +- Tell Autopilot to have a specific teammate review a pull request. +- Ask Autopilot to set up a new automation. -Chats require the editor or admin [role](/dashboard/roles). You cannot start a new chat while Autopilot is turned off. +Chats require the editor or admin [role](/dashboard/roles). You cannot start a new chat while Autopilot is paused. -When Autopilot is enabled for your project, you can also ask the [editor agent](/editor/agent) about Autopilot's pull requests, schedule, and setup. +## Pause Autopilot -## Turn off Autopilot +To pause Autopilot, switch off the toggle on the **Autopilot** card. -To turn off Autopilot, switch off the toggle on the **Autopilot** card. The card shows **Paused** while Autopilot is off and **Enabled** while it is on. - -While Autopilot is off, it does not start new work. Work that comes in while it is off waits until you turn Autopilot back on. +TODO: When you pause Autopilot, it does not start new work. Work that comes in while it is paused waits until you resume Autopilot. ### 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. The Autopilot page shows **Autopilot paused because you ran out of credits**. [Add credits](/credits#credit-add-ons), then switch the toggle back on. Organizations that [bring their own model](/ai/bring-your-own-model) skip this check. -- Your plan no longer includes Autopilot. The Autopilot page shows the **Unlock Autopilot** prompt. To resume, upgrade to a plan that includes Autopilot. - -When Autopilot pauses itself, Mintlify emails the person who enabled Autopilot, if they are still in your organization. Otherwise, Mintlify emails your organization's [admin contact emails](/dashboard/notifications#organization-contacts). Turning off Autopilot yourself does not send an email. +- 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. -Work that comes in during an automatic pause runs when Autopilot resumes. +When you enable Autopilot after an automatic pause, it completes any work that was in progress when it paused. ## Credits -Each Autopilot run that opens or updates a pull request costs 250 credits, the same as an [automation update](/credits#automation-updates). Runs that do not open or update a pull request cost nothing. +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. -Chatting with Autopilot uses the editor agent, which does not consume credits. See [Credit pricing](/credits) for how your organization's balance works. +See [Credit pricing](/credits) for more information. From a39d00ce1551ec6f0b0866ed2f93a12cb161b35f Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 15:35:55 -0700 Subject: [PATCH 7/9] docs: fix Autopilot chat example and automations sentence Autopilot can't create automations; replace the example with a scheduled check it can set up. Co-Authored-By: Claude Opus 5.5 (1M context) --- autopilot.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/autopilot.mdx b/autopilot.mdx index c39dc59e45..f01cb7c861 100644 --- a/autopilot.mdx +++ b/autopilot.mdx @@ -13,7 +13,7 @@ keywords: ["self-updating docs", "docs maintenance"] 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 run to build context about your site and content needs. +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. @@ -92,7 +92,7 @@ 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 set up a new automation. +- 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. From adc8ed224048264c821b6c128ea2a6620d5f6fea Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 15:39:48 -0700 Subject: [PATCH 8/9] remove todo --- autopilot.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/autopilot.mdx b/autopilot.mdx index f01cb7c861..b01c6722d9 100644 --- a/autopilot.mdx +++ b/autopilot.mdx @@ -100,7 +100,7 @@ Chats require the editor or admin [role](/dashboard/roles). You cannot start a n To pause Autopilot, switch off the toggle on the **Autopilot** card. -TODO: When you pause Autopilot, it does not start new work. Work that comes in while it is paused waits until you resume Autopilot. +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 From 3c6a40d45a38a0a6b71c9dac083111a7705f1673 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 19 Oct 2026 16:34:16 -0700 Subject: [PATCH 9/9] Apply suggestion from @ethanpalm --- autopilot.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/autopilot.mdx b/autopilot.mdx index b01c6722d9..da42000886 100644 --- a/autopilot.mdx +++ b/autopilot.mdx @@ -109,8 +109,6 @@ Before each run, Autopilot checks your plan and credits. It pauses itself instea - 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. -When you enable Autopilot after an automatic pause, it completes any work that was in progress when it paused. - ## 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.