-
Notifications
You must be signed in to change notification settings - Fork 214
Document agent suggestions CI check #2348
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,7 @@ | |
| 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. | ||
|
|
||
| Use suggestions to proactively keep your documentation up to date when new features or updates ship. | ||
|
|
||
|
|
@@ -32,10 +32,10 @@ | |
| <img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" /> | ||
| <img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" /> | ||
| </Frame> | ||
| 1. In the **Monitor Repositories** section, click the 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. When a pull request merges to this branch, the agent analyzes the changes and creates suggestions. | ||
| The agent monitors the default branch (typically `main`) for each repository. When you open a pull request in a monitored repository, a GitHub check named **Mintlify Autopilot** runs to analyze the pull request for potential documentation updates. When you merge a pull request that requires documentation updates, the agent creates a suggestion in your dashboard. | ||
|
|
||
| <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. | ||
|
|
@@ -49,14 +49,14 @@ | |
| <img src="/images/agent/dashboard-settings-light.png" alt="The settings button in light mode." className="block dark:hidden" /> | ||
| <img src="/images/agent/dashboard-settings-dark.png" alt="The settings button in dark mode." className="hidden dark:block" /> | ||
| </Frame> | ||
| 1. In the **Monitor Repositories** section, click the 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. | ||
|
|
||
| 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. | ||
|
|
||
|
|
@@ -80,4 +80,4 @@ | |
| 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. | ||
|
|
||
| The suggestion is immediately removed from your dashboard. You cannot retrieve dismissed suggestions. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This still triggers on a pull request merged. Everything else is still acurate