From 14e5bdf43c0c05d36920823cccd8a76873d14a31 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 16 Dec 2025 09:20:48 -0800 Subject: [PATCH 1/2] add info on CI check --- ai/suggestions.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ai/suggestions.mdx b/ai/suggestions.mdx index cc17303e1..c26516107 100644 --- a/ai/suggestions.mdx +++ b/ai/suggestions.mdx @@ -35,7 +35,7 @@ After installing the Mintlify GitHub App on your organizations, select which rep 1. In the **Monitor Repositories** section, click the the organization name that contains the repositories you want to monitor. 1. Click the toggle on next to each repository you want to monitor, or click **Enable all** to monitor all repositories in the organization. -The agent monitors the default branch (typically `main`) for each repository. When a pull request merges to this branch, the agent analyzes the changes and creates suggestions. +The agent monitors the default branch (typically `main`) for each repository. When you open a pull request in a monitored repository, a GitHub check named **Mintlify Autopilot** runs to analyze the pull request for potential documentation updates. When you merge a pull request that requires documentation updates, the agent creates a suggestion in your dashboard. When you first enable monitoring for a repository, the agent creates suggestions for pull requests merged in the last seven days. This backfill only occurs if no suggestions already exist for that repository. You may see multiple suggestions appear immediately after enabling monitoring. From 91b1292657f61f960b3af97b19081abf0c1c2459 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Tue, 16 Dec 2025 16:58:25 -0800 Subject: [PATCH 2/2] reviewer feedback and linter warnings --- ai/suggestions.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ai/suggestions.mdx b/ai/suggestions.mdx index c26516107..7b7da3d4c 100644 --- a/ai/suggestions.mdx +++ b/ai/suggestions.mdx @@ -32,10 +32,10 @@ After installing the Mintlify GitHub App on your organizations, select which rep The settings button in light mode. The settings button in dark mode. -1. In the **Monitor Repositories** section, click the the organization name that contains the repositories you want to monitor. +1. In the **Monitor Repositories** section, click the organization name that contains the repositories you want to monitor. 1. Click the toggle on next to each repository you want to monitor, or click **Enable all** to monitor all repositories in the organization. -The agent monitors the default branch (typically `main`) for each repository. When you open a pull request in a monitored repository, a GitHub check named **Mintlify Autopilot** runs to analyze the pull request for potential documentation updates. When you merge a pull request that requires documentation updates, the agent creates a suggestion in your dashboard. +The agent monitors the default branch (typically `main`) for each repository. A GitHub check named **Mintlify Autopilot** runs on pull requests in monitored repositories to analyze them for potential documentation updates. When you merge a pull request that requires documentation updates, the agent creates a suggestion in your dashboard. When you first enable monitoring for a repository, the agent creates suggestions for pull requests merged in the last seven days. This backfill only occurs if no suggestions already exist for that repository. You may see multiple suggestions appear immediately after enabling monitoring. @@ -49,14 +49,14 @@ The agent monitors the default branch (typically `main`) for each repository. Wh The settings button in light mode. The settings button in dark mode. -1. In the **Monitor Repositories** section, click the the organization name that contains the repositories you want to stop monitoring. +1. In the **Monitor Repositories** section, click the organization name that contains the repositories you want to stop monitoring. 1. Click the toggle off next to the repository you want to stop monitoring, or click **Disable all** to stop monitoring all repositories in the organization. The agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them. ## Review suggestions -When the agent 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, when the suggestion was created, and proposed documentation updates. +When the agent detects user-facing changes in your monitored repositories, it creates a suggestion in your dashboard. Each suggestion shows the pull request title, repository name, creation date, and proposed documentation updates. The **Ask agent** button in your dashboard displays the number of suggestions waiting for your review.