Skip to content

Commit 0f5bcd0

Browse files
ethanpalmclaude
andauthored
docs(agent): add notification subscription settings to suggestions (#2430)
* docs(agent): add notification subscription settings to suggestions Add documentation for email and Slack notification subscriptions for agent suggestions. Users can now configure notifications in the agent settings panel to receive alerts when new suggestions are created. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * copy edit --------- Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 2e30e26 commit 0f5bcd0

File tree

1 file changed

+13
-20
lines changed

1 file changed

+13
-20
lines changed

ai/suggestions.mdx

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,34 @@ Before using suggestions, you must install the [Mintlify GitHub App](/deploy/git
1818

1919
## Configure suggestions
2020

21-
Configure which repositories the agent makes suggestions for in the agent settings.
21+
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.
2222

23-
The configuration page displays all GitHub organizations where you've installed the Mintlify GitHub App and which repositories the agent is monitoring.
24-
25-
### Select repositories to monitor
26-
27-
After installing the Mintlify GitHub App on your organizations, select which repositories to monitor.
23+
To access the agent settings:
2824

2925
1. Click the **Ask agent** button in your dashboard to open the agent panel.
3026
1. Click the **Settings** button.
3127
<Frame>
3228
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
3329
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
3430
</Frame>
35-
1. In the **Monitor Repositories** section, click the organization name that contains the repositories you want to monitor.
36-
1. Click the toggle on next to each repository you want to monitor, or click **Enable all** to monitor all repositories in the organization.
3731

38-
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.
32+
### Monitor repositories
33+
34+
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.
3935

4036
<Note>
4137
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.
4238
</Note>
4339

44-
### Stop monitoring a repository
40+
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.
4541

46-
1. Click the **Ask agent** button in your dashboard to open the agent panel.
47-
1. Click the **Settings** button.
48-
<Frame>
49-
<img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" />
50-
<img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" />
51-
</Frame>
52-
1. In the **Monitor Repositories** section, click the organization name that contains the repositories you want to stop monitoring.
53-
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.
42+
### Notifications
43+
44+
Agent suggestions always appear in your dashboard. You can configure notifications to receive email or Slack direct messages when the agent creates new suggestions.
5445

55-
The agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them.
46+
<Tip>
47+
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.
48+
</Tip>
5649

5750
## Review suggestions
5851

@@ -78,6 +71,6 @@ Add suggestions as context for the agent to create pull requests.
7871
If a suggestion doesn't require documentation updates or you've already addressed the changes, dismiss it to remove it from your dashboard.
7972

8073
1. Click the **Ask agent** button in your dashboard to open the agent panel.
81-
1. Click the **Dismiss** button next any suggestions that you want to dismiss.
74+
1. Click the **Dismiss** button next to any suggestions that you want to dismiss.
8275

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

0 commit comments

Comments
 (0)