Skip to content

Update agent documentation for dashboard panel #1955

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.

Sign up for GitHub

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 4 commits into from
Dec 1, 2025
Merged

Update agent documentation for dashboard panel #1955

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
29532d7
Update ai/agent.mdx
mintlify[bot] Nov 30, 2025
e178aad
Update ai/agent.mdx
mintlify[bot] Nov 30, 2025
67e4a15
Update ai/agent.mdx
mintlify[bot] Nov 30, 2025
1a839bd
Apply suggestions from code review
ethanpalm Dec 1, 2025
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
22 changes: 17 additions & 5 deletions ai/agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The agent is available on [Pro and Custom plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard.
</Info>

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

Use the agent to:

Expand All @@ -17,16 +17,28 @@
- Search and update existing content
- Answer questions about your docs and technical writing topics

To get started, add the agent to your Slack workspace and mention it with `@mintlify` in a channel.
## Use the agent in the dashboard

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.

The agent panel includes:

- **Chat**: Send prompts and receive responses with proposed documentation changes.
- **History**: View and continue previous conversations.
- **Settings**: Configure GitHub App permissions and Slack integration.

When the agent makes changes, you can view the pull request directly from the chat or open the changes in the web editor.

## Add the agent to your Slack workspace

You can also 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 37 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L37 

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

1. Navigate to the [agent](https://dashboard.mintlify.com/products/agent) page of your dashboard.
2. Select the **Connect** button.
1. Open the agent panel in your dashboard and navigate to **Settings**.
2. Select the **Connect** button in the Slack integration section.
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 @@ -35,7 +47,7 @@

## Connect repositories as context

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

## Embed the agent via API

Expand Down