Skip to content
Merged
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
8 changes: 4 additions & 4 deletions ai/suggestions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Agent suggestions are available on [Custom plans](https://mintlify.com/pricing?ref=autopilot). To enable suggestions for your organization, [contact our sales team](mailto:gtm@mintlify.com).
</Note>

You can allow the [agent](/ai/agent) to monitor your selected Git repositories and suggest documentation updates. When the agent identifies potential user-facing changes in your application, it prepares context for you to create a pull request to update your documentation with one click.

Check warning on line 11 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L11

Use 'app' instead of 'application'.

Use suggestions to proactively keep your documentation up to date when new features or updates ship.

Expand All @@ -32,10 +32,10 @@
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
</Frame>
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 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. 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.

Check warning on line 38 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L38

Use parentheses judiciously.

<Note>
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.
Expand All @@ -49,14 +49,14 @@
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
</Frame>
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.

Expand All @@ -80,4 +80,4 @@
1. Click the **Ask agent** button in your dashboard to open the agent panel.
1. Click the **Dismiss** button next any suggestions that you want to dismiss.

The suggestion is immediately removed from your dashboard. You cannot retrieve dismissed suggestions.

Check warning on line 83 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L83

Use 'can't' instead of 'cannot'.