You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: ai/suggestions.mdx
+13-20Lines changed: 13 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,41 +18,34 @@ Before using suggestions, you must install the [Mintlify GitHub App](/deploy/git
18
18
19
19
## Configure suggestions
20
20
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.
22
22
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:
28
24
29
25
1. Click the **Ask agent** button in your dashboard to open the agent panel.
30
26
1. Click the **Settings** button.
31
27
<Frame>
32
28
<imgsrc="/images/agent/dashboard-settings-light.png"alt="The settings button in light mode."className="block dark:hidden" />
33
29
<imgsrc="/images/agent/dashboard-settings-dark.png"alt="The settings button in dark mode."className="hidden dark:block" />
34
30
</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.
37
31
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.
39
35
40
36
<Note>
41
37
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.
42
38
</Note>
43
39
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.
45
41
46
-
1. Click the **Ask agent** button in your dashboard to open the agent panel.
47
-
1. Click the **Settings** button.
48
-
<Frame>
49
-
<imgsrc="/images/agent/dashboard-settings-light.png"alt="The settings button in light mode."className="block dark:hidden" />
50
-
<imgsrc="/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.
54
45
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>
56
49
57
50
## Review suggestions
58
51
@@ -78,6 +71,6 @@ Add suggestions as context for the agent to create pull requests.
78
71
If a suggestion doesn't require documentation updates or you've already addressed the changes, dismiss it to remove it from your dashboard.
79
72
80
73
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.
82
75
83
76
The suggestion is immediately removed from your dashboard. You cannot retrieve dismissed suggestions.
0 commit comments