Skip to content
Merged
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
14 changes: 12 additions & 2 deletions ai/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,22 @@
- Search and update existing content
- Answer questions about your docs and technical writing topics

## 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.

- **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.
- **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.

## Add the agent to your Slack workspace

You can also use the agent in Slack to collaborate with your team on documentation updates.
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 35 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L35

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

1. Open the agent panel in your dashboard.
Expand All @@ -31,7 +41,7 @@
<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>
2. Select the **Connect** button in the Slack integration section.
2. In the Slack integration section, click **Connect**.
3. Follow the Slack prompts to add the `mintlify` app to your workspace.
4. Follow the Slack prompts to link your Mintlify account to your Slack workspace.
5. Test that the agent is working and responds when you:
Expand All @@ -46,7 +56,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 59 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L59

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

## Write effective prompts

Expand Down