Skip to main content
Agent suggestions are available on Custom plans. To enable suggestions for your organization, contact our sales team.
You can allow the 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. Use suggestions to proactively keep your documentation up to date when new features or updates ship.

​
Prerequisites

Before using suggestions, you must install the Mintlify GitHub App in your organization. The app must have access to your documentation repository and at least one other repository where code changes require documentation updates.

​
Configure suggestions

Configure which repositories the agent makes suggestions for in the agent settings. 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.
  1. Click the Ask agent button in your dashboard to open the agent panel.
  2. Click the Settings button.
    The settings button in light mode.
  3. In the Monitor Repositories section, click the the organization name that contains the repositories you want to monitor.
  4. 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.

​
Stop monitoring a repository

  1. Click the Ask agent button in your dashboard to open the agent panel.
  2. Click the Settings button.
    The settings button in light mode.
  3. In the Monitor Repositories section, click the the organization name that contains the repositories you want to stop monitoring.
  4. 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. The Ask agent button in your dashboard displays the number of suggestions waiting for your review.
The Ask agent button showing four suggestions in light mode.

​
Create pull requests

Add suggestions as context for the agent to create pull requests.
  1. Click the Ask agent button in your dashboard to open the agent panel.
  2. Click Add to chat.
  3. Submit the prompt to the agent to open a pull request.

​
Dismiss suggestions

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.
  2. 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.