Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ai/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@

## Use the agent in the dashboard

Access the agent in a from your dashboard using the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux), or by clicking the **Ask agent** button. The agent panel is resizable on desktop. On mobile devices, the agent opens in full-screen.

Check warning on line 22 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L22

Did you really mean 'resizable'?

The agent panel has three views.
The agent panel has four views.

- **Chat**: Send prompts to the agent to update your documentation. The agent creates pull requests based on your instructions and displays links to view the pull requests or open the changes in the web editor.
- **Suggestions**: View documentation update suggestions based on changes in your monitored Git repositories. A notification badge displays the number of open suggestions. Learn more about [agent suggestions](/ai/suggestions).
- **History**: Browse past conversations and continue working on previous requests. Click any conversation to load it in the chat view.
- **Settings**: Configure the agent's integrations and repository access.

Expand All @@ -32,7 +33,7 @@
Use the agent in Slack to collaborate with your team on documentation updates.

<Note>
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it.

Check warning on line 36 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L36

Use 'administrator' instead of 'admin'.
</Note>

1. Open the agent panel in your dashboard.
Expand Down Expand Up @@ -78,7 +79,7 @@

Use the agent endpoints to [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs).

When creating jobs via the API, you can control whether pull requests are created in draft mode using the `asDraft` parameter (defaults to `true`). Set `asDraft: false` to create non-draft pull requests ready for immediate review and merging in automated workflows.

Check warning on line 82 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L82

In general, use active voice instead of passive voice ('are created').

## Write effective prompts

Expand Down
20 changes: 11 additions & 9 deletions ai/suggestions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:gtm@mintlify.com).
</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.

Check warning on line 11 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L11

Use 'app' instead of 'application'.

Use suggestions to proactively keep your documentation up to date when new features or updates ship.

Expand All @@ -18,9 +18,9 @@

## Configure suggestions

Configure which repositories the agent makes suggestions for in the agent settings.
Configure which repositories the agent makes suggestions for in the Agent panel Settings view.

The configuration page displays all GitHub organizations where you've installed the Mintlify GitHub App and which repositories the agent is monitoring.
The Settings view displays all GitHub organizations where you've installed the Mintlify GitHub App and which repositories the agent is monitoring.

### Select repositories to monitor

Expand All @@ -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.

Check warning on line 35 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L35

'the' is repeated!
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.

Check warning on line 38 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L38

Use parentheses judiciously.

### Stop monitoring a repository

Expand All @@ -45,16 +45,16 @@
<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.

Check warning on line 48 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L48

'the' is repeated!
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.
When the agent detects user-facing changes in your monitored repositories, it creates suggestions that appear in the Agent panel's Suggestions tab. Each suggestion displays the pull request title, repository name, when the suggestion was created, and proposed documentation updates.

Check warning on line 55 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L55

In general, use active voice instead of passive voice ('was created').

The **Ask agent** button in your dashboard displays the number of suggestions waiting for your review.
The **Ask agent** button and the **Suggestions** button in the agent panel header display notification badges showing the number of open suggestions waiting for your review.

<Frame>
<img src="/images/suggestions/count-light.png" alt="The Ask agent button showing four suggestions in light mode." className="block dark:hidden" />
Expand All @@ -66,14 +66,16 @@
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.
1. Click **Add to chat**.
1. Submit the prompt to the agent to open a pull request.
1. Click the **Suggestions** button in the agent panel header to view all suggestions.
1. Click **Add to chat** on any suggestion you want to address.
1. The agent switches to the Chat view with the suggestion context loaded. Submit the prompt to create 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.
If a suggestion doesn't require documentation updates or you've already addressed the changes, dismiss it to remove it from the Suggestions tab.

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 **Suggestions** button in the agent panel header to view all suggestions.
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.
The suggestion is immediately removed from the Suggestions tab. You cannot retrieve dismissed suggestions.

Check warning on line 81 in ai/suggestions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/suggestions.mdx#L81

Use 'can't' instead of 'cannot'.