Skip to content

Commit 54049ea

Browse files
Update agent documentation for dashboard panel (#1955)
* Update ai/agent.mdx * Update ai/agent.mdx * Update ai/agent.mdx * Apply suggestions from code review --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
1 parent 31a8208 commit 54049ea

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

ai/agent.mdx

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: ["automation", "automate", "Slack integration", "maintenance"]
88
The agent is available on [Pro and Custom plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard.
99
</Info>
1010

11-
The agent creates pull requests with proposed changes to your documentation based on your prompts. When you send a request to the agent, it references your documentation, connected repositories, and Slack messages to create content that follows technical writing best practices and adheres to the Mintlify schema. Access the agent in your Slack workspace or embed it in custom applications with the API.
11+
The agent creates pull requests with proposed changes to your documentation based on your prompts. When you send a request to the agent, it references your documentation, connected repositories, and Slack messages to create content that follows technical writing best practices and adheres to the Mintlify schema. Access the agent directly in your dashboard, in your Slack workspace, or embed it in custom applications with the API.
1212

1313
Use the agent to:
1414

@@ -17,16 +17,28 @@ Use the agent to:
1717
- Search and update existing content
1818
- Answer questions about your docs and technical writing topics
1919

20-
To get started, add the agent to your Slack workspace and mention it with `@mintlify` in a channel.
20+
## Use the agent in the dashboard
21+
22+
Access the agent panel directly from your dashboard using the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux), or by clicking the **Ask agent** button.
23+
24+
The agent panel includes:
25+
26+
- **Chat**: Send prompts and receive responses with proposed documentation changes.
27+
- **History**: View and continue previous conversations.
28+
- **Settings**: Configure GitHub App permissions and Slack integration.
29+
30+
When the agent makes changes, you can view the pull request directly from the chat or open the changes in the web editor.
2131

2232
## Add the agent to your Slack workspace
2333

34+
You can also use the agent in Slack to collaborate with your team on documentation updates.
35+
2436
<Note>
2537
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it.
2638
</Note>
2739

28-
1. Navigate to the [agent](https://dashboard.mintlify.com/products/agent) page of your dashboard.
29-
2. Select the **Connect** button.
40+
1. Open the agent panel in your dashboard and navigate to **Settings**.
41+
2. Select the **Connect** button in the Slack integration section.
3042
3. Follow the Slack prompts to add the `mintlify` app to your workspace.
3143
4. Follow the Slack prompts to link your Mintlify account to your Slack workspace.
3244
5. Test that the agent is working and responds when you:
@@ -35,7 +47,7 @@ To get started, add the agent to your Slack workspace and mention it with `@mint
3547

3648
## Connect repositories as context
3749

38-
The agent can only access repositories that you connect through the Mintlify GitHub App. Modify which repositories the agent can access in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).
50+
The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).
3951

4052
## Embed the agent via API
4153

0 commit comments

Comments
 (0)