mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Mintlify Agent
39 lines
3.2 KiB
Plaintext
39 lines
3.2 KiB
Plaintext
---
|
|
title: "Quickstart"
|
|
description: "Start using the agent in your dashboard to create documentation updates."
|
|
keywords: ["agent setup"]
|
|
---
|
|
|
|
## Open the agent panel
|
|
|
|
On desktop, the agent panel is resizable. On mobile devices, the agent opens in full-screen.
|
|
|
|
To open the agent panel:
|
|
|
|
- From any page in your dashboard, use the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux).
|
|
- On the [Overview](https://dashboard.mintlify.com/) page, click **Ask agent**.
|
|
|
|
### Agent panel views
|
|
|
|
<Frame>
|
|
<img src="/images/agent/views-light.png" alt="Views in the agent panel: new chat, suggestions, history, and settings." className="block dark:hidden" />
|
|
<img src="/images/agent/views-dark.png" alt="Views in the agent panel: new chat, suggestions, history, and settings." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
- **Chat**: Click the plus icon, <Icon icon="plus" />, to start a new chat. In the chat view, send prompts to the agent to update or ask questions about 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**: If enabled, the suggestions panel shows suggested updates to your documentation based on pull request changes and users' conversations with the assistant.
|
|
- **History**: Click the history icon, <Icon icon="clock" />, to browse past conversations and continue working on previous requests. Click any conversation to load it in the chat view.
|
|
- **Settings**: Click the settings icon, <Icon icon="settings" />, to configure the agent's integrations and <span style={{ backgroundImage: 'linear-gradient(90deg, #ff0000, #ff7f00, #ffff00, #00ff00, #0000ff, #4b0082, #9400d3)', backgroundClip: 'text', WebkitBackgroundClip: 'text', WebkitTextFillColor: 'transparent' }}>repository</span> access.
|
|
|
|
<Tip>
|
|
Start a new conversation with the agent for each task. This keeps the agent's context focused and helps you associate conversations with specific projects.
|
|
</Tip>
|
|
|
|
## Connect your GitHub account
|
|
|
|
By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://dashboard.mintlify.com/settings/account) page of the dashboard.
|
|
|
|
## Connect <span style={{ backgroundImage: 'linear-gradient(90deg, #ff0000, #ff7f00, #ffff00, #00ff00, #0000ff, #4b0082, #9400d3)', backgroundClip: 'text', WebkitBackgroundClip: 'text', WebkitTextFillColor: 'transparent' }}>repositories</span> as context
|
|
|
|
The agent can only access <span style={{ backgroundImage: 'linear-gradient(90deg, #ff0000, #ff7f00, #ffff00, #00ff00, #0000ff, #4b0082, #9400d3)', backgroundClip: 'text', WebkitBackgroundClip: 'text', WebkitTextFillColor: 'transparent' }}>repositories</span> that you connect through the Mintlify GitHub App. Configure which <span style={{ backgroundImage: 'linear-gradient(90deg, #ff0000, #ff7f00, #ffff00, #00ff00, #0000ff, #4b0082, #9400d3)', backgroundClip: 'text', WebkitBackgroundClip: 'text', WebkitTextFillColor: 'transparent' }}>repositories</span> the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).
|