From 770daaa15121528f4688168e9212f5616fbcbb85 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 18 Dec 2025 09:27:08 -0800 Subject: [PATCH 1/2] docs(agent): add notification subscription settings to suggestions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- ai/suggestions.mdx | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/ai/suggestions.mdx b/ai/suggestions.mdx index 7b7da3d4c..c0d436f4e 100644 --- a/ai/suggestions.mdx +++ b/ai/suggestions.mdx @@ -54,6 +54,24 @@ The agent monitors the default branch (typically `main`) for each repository. A The agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them. +## Subscribe to notifications + +Receive email or Slack notifications when the agent creates new suggestions. + +### Configure notification settings + +1. Click the **Ask agent** button in your dashboard to open the agent panel. +1. Click the **Settings** button. + + The settings button in light mode. + The settings button in dark mode. + +1. Toggle the notification types you want to receive: + - **Email notifications**: Receive email notifications when the agent creates new suggestions. + - **Slack notifications**: Receive Slack direct messages when the agent creates new suggestions. + +When you enable notifications, you receive a notification each time the agent creates a new suggestion that requires documentation updates. + ## 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. From 532c33e14de9e638e819a2d1810936079e5502fd Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 18 Dec 2025 11:52:50 -0800 Subject: [PATCH 2/2] copy edit --- ai/suggestions.mdx | 49 ++++++++++++---------------------------------- 1 file changed, 12 insertions(+), 37 deletions(-) diff --git a/ai/suggestions.mdx b/ai/suggestions.mdx index c0d436f4e..c8d05ac50 100644 --- a/ai/suggestions.mdx +++ b/ai/suggestions.mdx @@ -18,13 +18,9 @@ Before using suggestions, you must install the [Mintlify GitHub App](/deploy/git ## 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. @@ -32,45 +28,24 @@ After installing the Mintlify GitHub App on your organizations, select which rep The settings button in light mode. The settings button in dark mode. -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. 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. -### Stop monitoring a repository - -1. Click the **Ask agent** button in your dashboard to open the agent panel. -1. Click the **Settings** button. - - The settings button in light mode. - The settings button in dark mode. - -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. +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. -The agent immediately stops monitoring the repository. Any existing suggestions for that repository remain in your dashboard until you dismiss them. +### Notifications -## Subscribe to notifications - -Receive email or Slack notifications when the agent creates new suggestions. - -### Configure notification settings - -1. Click the **Ask agent** button in your dashboard to open the agent panel. -1. Click the **Settings** button. - - The settings button in light mode. - The settings button in dark mode. - -1. Toggle the notification types you want to receive: - - **Email notifications**: Receive email notifications when the agent creates new suggestions. - - **Slack notifications**: Receive Slack direct messages when the agent creates new suggestions. +Agent suggestions always appear in your dashboard. You can configure notifications to receive email or Slack direct messages when the agent creates new suggestions. -When you enable notifications, you receive a notification each time the agent creates a new suggestion that requires documentation updates. + + 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. + ## Review suggestions @@ -96,6 +71,6 @@ Add suggestions as context for the agent to create pull requests. 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.