|
| 1 | +--- |
| 2 | +title: "Autopilot" |
| 3 | +description: "Monitor Git repositories for changes and receive suggested documentation updates." |
| 4 | +keywords: ["automation", "documentation gaps", "self updating", "self-updating", "automate updates"] |
| 5 | +--- |
| 6 | + |
| 7 | +<Note> |
| 8 | + Autopilot is available on [Custom plans ](https://mintlify.com/pricing?ref=autopilot). To enable autopilot for your organization, [contact our sales team ](mailto:[email protected]). |
| 9 | +</Note> |
| 10 | + |
| 11 | +Autopilot monitors your selected Git repositories and suggests documentation updates. Autopilot flags potential user-facing changes in your application and prepares context for the agent to draft a pull request to update your documentation. |
| 12 | + |
| 13 | +Use autopilot to proactively keep your documentation up to date when new features or updates ship. |
| 14 | + |
| 15 | +## Prerequisites |
| 16 | + |
| 17 | +Before using autopilot, you must install the [Mintlify GitHub App](/deploy/github) in your organization. The app must have access to your documentation repository and at least one other repository where code changes require documentation updates. |
| 18 | + |
| 19 | +## Access autopilot |
| 20 | + |
| 21 | +Navigate to the [autopilot page](https://dashboard.mintlify.com/products/autopilot) in your dashboard to view suggestions and configure repository monitoring. The autopilot page shows pending suggestions that need your review and provides access to configuration settings. |
| 22 | + |
| 23 | +## Configure autopilot |
| 24 | + |
| 25 | +Configure autopilot settings from the autopilot page by clicking the **Configuration** button. |
| 26 | + |
| 27 | +<Frame> |
| 28 | + <img src="/images/autopilot/configuration-button-light.png" alt="The autopilot configuration page in light mode." className="block dark:hidden" /> |
| 29 | + <img src="/images/autopilot/configuration-button-dark.png" alt="The autopilot configuration page in dark mode." className="hidden dark:block" /> |
| 30 | +</Frame> |
| 31 | + |
| 32 | +The configuration page displays all GitHub organizations where you've installed the Mintlify GitHub App and which repositories autopilot is monitoring. |
| 33 | + |
| 34 | +### Select repositories to monitor |
| 35 | + |
| 36 | +After installing the Mintlify GitHub App on your organizations, you can select which repositories to monitor. |
| 37 | + |
| 38 | +1. Navigate to the [autopilot settings page](https://dashboard.mintlify.com/products/autopilot/settings). |
| 39 | +1. Find the GitHub organization that the repository you want to monitor belongs to. |
| 40 | +1. Click the gear icon next to the organization name. |
| 41 | + <Frame> |
| 42 | + <img src="/images/autopilot/org-config-light.png" alt="The gear icon next to the organization name in light mode." className="block dark:hidden" /> |
| 43 | + <img src="/images/autopilot/org-config-dark.png" alt="The gear icon next to the organization name in dark mode." className="hidden dark:block" /> |
| 44 | + </Frame> |
| 45 | +1. Click the toggle on next to each repository you want to monitor. |
| 46 | +1. Use the search bar to filter repositories by name. |
| 47 | +1. Click **Enable all** or **Disable all** to quickly configure all repositories. |
| 48 | + |
| 49 | +Autopilot monitors the default branch (typically `main`) for each repository. When a pull request merges to this branch, autopilot analyzes the changes and creates suggestions. |
| 50 | + |
| 51 | +### Stop monitoring a repository |
| 52 | + |
| 53 | +1. Navigate to the [autopilot settings page](https://dashboard.mintlify.com/products/autopilot/settings). |
| 54 | +1. Find the GitHub organization that the repository you want to stop monitoring belongs to. |
| 55 | +1. Click the gear icon next to the organization name. |
| 56 | + <Frame> |
| 57 | + <img src="/images/autopilot/org-config-light.png" alt="The gear icon next to the organization name in light mode." className="block dark:hidden" /> |
| 58 | + <img src="/images/autopilot/org-config-dark.png" alt="The gear icon next to the organization name in dark mode." className="hidden dark:block" /> |
| 59 | + </Frame> |
| 60 | +1. Click the toggle off next to the repository you want to stop monitoring. |
| 61 | +1. Use the search bar to filter repositories by name. |
| 62 | + |
| 63 | +Autopilot stops monitoring the repository immediately. Any existing suggestions for that repository remain in your dashboard until you dismiss them. |
| 64 | + |
| 65 | +## Review suggestions |
| 66 | + |
| 67 | +When autopilot detects user-facing changes in your monitored repositories, it creates suggestions that appear in your dashboard. Each suggestion displays the pull request title, repository name, summary for why the change may need documentation updates, and when the suggestion was created. |
| 68 | + |
| 69 | +### Apply suggestions |
| 70 | + |
| 71 | +When you apply a suggestion, autopilot opens the [agent](/ai/agent) panel with context about the pull request. The agent receives the pull request URL and a summary about the changed files. |
| 72 | + |
| 73 | +1. Navigate to the [autopilot page](https://dashboard.mintlify.com/products/autopilot) in your dashboard. |
| 74 | +1. Click **Apply suggestion**. |
| 75 | +1. Use the agent interface to refine the suggested documentation updates or create a pull request. |
| 76 | + |
| 77 | +### Dismiss suggestions |
| 78 | + |
| 79 | +If a suggestion doesn't require documentation updates or you've already addressed the changes, dismiss it to remove it from your dashboard. |
| 80 | + |
| 81 | +1. Navigate to the [autopilot page](https://dashboard.mintlify.com/products/autopilot) in your dashboard. |
| 82 | +1. Click **Dismiss**. |
| 83 | + |
| 84 | +The suggestion is immediately removed from your visible list. You cannot retrieve dismissed suggestions. |
0 commit comments