Skip to content

Commit 0ecd817

Browse files
authored
Document agent suggestions CI check (#2348)
* add info on CI check * reviewer feedback and linter warnings
1 parent ed76e2a commit 0ecd817

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

ai/suggestions.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ After installing the Mintlify GitHub App on your organizations, select which rep
3232
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
3333
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
3434
</Frame>
35-
1. In the **Monitor Repositories** section, click the the organization name that contains the repositories you want to monitor.
35+
1. In the **Monitor Repositories** section, click the organization name that contains the repositories you want to monitor.
3636
1. Click the toggle on next to each repository you want to monitor, or click **Enable all** to monitor all repositories in the organization.
3737

38-
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.
38+
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.
3939

4040
<Note>
4141
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
4949
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
5050
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
5151
</Frame>
52-
1. In the **Monitor Repositories** section, click the the organization name that contains the repositories you want to stop monitoring.
52+
1. In the **Monitor Repositories** section, click the organization name that contains the repositories you want to stop monitoring.
5353
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.
5454

5555
The agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them.
5656

5757
## Review suggestions
5858

59-
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.
59+
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.
6060

6161
The **Ask agent** button in your dashboard displays the number of suggestions waiting for your review.
6262

0 commit comments

Comments
 (0)