Skip to content
Closed
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
24 changes: 24 additions & 0 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 @@ -35,7 +35,7 @@
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. 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 Down Expand Up @@ -80,4 +80,28 @@
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'.

## Notifications

Receive notifications when the agent creates new suggestions. You can configure email and Slack notifications to stay informed about documentation updates without checking the dashboard.

### Configure notification preferences

Configure your notification preferences in the agent settings.

1. Click the **Ask agent** button in your dashboard to open the agent panel.
1. Click the **Settings** button.
1. In the notification settings, select your preferred frequency for email and Slack notifications.

Set the frequency to **per-merge** to receive a notification each time the agent creates a suggestion from a merged pull request. This ensures you're immediately notified when new documentation updates are needed.

Check warning on line 97 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L97

In general, use active voice instead of passive voice ('are needed').

### Email notifications

Check warning on line 99 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L99

Use 'email' instead of 'Email'.

When email notifications are enabled with the per-merge frequency, you receive an email each time the agent creates a suggestion. The email includes the suggestion title, the pull request that triggered it, and a link to review the suggested changes in your dashboard.

Check warning on line 101 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L101

In general, use active voice instead of passive voice ('are enabled').

### Slack notifications

When Slack notifications are enabled with the per-merge frequency, you receive a Slack message each time the agent creates a suggestion. To receive Slack notifications, you must connect your Slack account to Mintlify.

Check warning on line 105 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L105

In general, use active voice instead of passive voice ('are enabled').

The Slack notification includes the suggestion details and a link to your dashboard where you can review and act on the suggestion.