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
17 changes: 14 additions & 3 deletions ai/suggestions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,14 @@
Agent suggestions are available on [Custom plans](https://mintlify.com/pricing?ref=autopilot). To enable suggestions for your organization, [contact our sales team](mailto:[email protected]).
</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.
You can allow the [agent](/ai/agent) to suggest documentation updates from two sources.

Use suggestions to proactively keep your documentation up to date when new features or updates ship.
- **Pull request changes**: Monitor selected Git repositories for code changes that require documentation updates.
- **Assistant conversations**: Analyze questions that users ask the assistant on your documentation site to identify content gaps.

When the agent identifies potential documentation updates, it creates a suggestion in your dashboard with context to create a pull request.

Use suggestions to proactively keep your documentation up to date when new features ship or to address common user questions.

## Prerequisites

Expand All @@ -31,14 +36,20 @@

### 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 39 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L39

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>

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 45 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L45

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

### Conversation insights

Enable conversation insights to receive suggestions based on common questions users ask the assistant.

When enabled, the agent periodically analyzes assistant conversations and creates suggestions when it identifies patterns of questions that indicate missing or unclear documentation.

### 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.
Expand All @@ -49,7 +60,7 @@

## Review suggestions

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 agent creates suggestions in your dashboard. Each suggestion shows the pull request or assistant conversation topic that triggered the suggestion, creation date, and proposed documentation updates.

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

Expand All @@ -73,4 +84,4 @@
1. Click the **Ask agent** button in your dashboard to open the agent panel.
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 87 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L87

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