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
33 changes: 13 additions & 20 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 @@ -18,41 +18,34 @@

## Configure suggestions

Configure which repositories the agent makes suggestions for in the agent settings.
Configure which repositories the agent monitors and how you receive notifications in the agent settings. The settings page displays all the GitHub organizations and repositories the agent is monitoring.

The configuration page displays all GitHub organizations where you've installed the Mintlify GitHub App and which repositories the agent is monitoring.

### Select repositories to monitor

After installing the Mintlify GitHub App on your organizations, select which repositories to monitor.
To access the agent settings:

1. Click the **Ask agent** button in your dashboard to open the agent panel.
1. Click the **Settings** button.
<Frame>
<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 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.
### Monitor repositories

The agent monitors the default branch (typically `main`) for each repository that you enable. 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 34 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L34

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.
</Note>

### Stop monitoring a repository
If you disable monitoring, the agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them.

Check warning on line 40 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L40

Use 'turn off' or 'off' instead of 'disable'.

1. Click the **Ask agent** button in your dashboard to open the agent panel.
1. Click the **Settings** button.
<Frame>
<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 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.
### Notifications

Agent suggestions always appear in your dashboard. You can configure notifications to receive email or Slack direct messages when the agent creates new suggestions.

The agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them.
<Tip>
If you don't receive email notifications for suggestions, check your spam folder and add the email address `notifications@mintlify.com` to your safe sender list.
</Tip>

## Review suggestions

Expand All @@ -78,6 +71,6 @@
If a suggestion doesn't require documentation updates or you've already addressed the changes, dismiss it to remove it from your dashboard.

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.
1. Click the **Dismiss** button next to any suggestions that you want to dismiss.

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

Check warning on line 76 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L76

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