Add the agent to Slack

Use the agent in Slack to make documentation updates from conversations and capture team knowledge.

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

Connect your Slack workspace

1. Go to the Agent page in your dashboard.
2. In the “Agent settings” section, click Install Slack app.

3. Follow the Slack prompts to install the mintlify app in 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:
   • Send a direct message to the agent.
   • Mention the agent with @mintlify in a channel.

Use the agent in Slack

Once connected, you can:

• Send direct messages to the agent to use it privately to update your documentation.
• Mention @mintlify in a channel to use it publicly and collaboratively.
• Attach files and images directly to your messages for the agent to process and include in your docs.
• Continue conversations in threads to iterate on changes.
• Share pull request links with the agent to update related documentation.

Update documentation

Use the agent to update your documentation with a new request or in an existing thread.

• New request: Send a direct message to the agent or mention @mintlify in a channel with instructions on what to update.
• Existing thread: Reply in the thread and mention @mintlify with instructions on what to update.
• With attachments: Upload images, diagrams, code files, or other documents with your message. The agent automatically processes and includes them in your documentation.

The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates.

Track progress in real time

While the agent works on your request, it provides live feedback in the Slack thread.

• Status updates: A live-updating message shows what the agent is doing, such as how many files it has searched, read, and edited.
• Task progress: When the agent breaks your request into multiple tasks, it displays a checklist so you can track progress on each one.
• Questions: If the agent needs more information, it presents options for you to select from or reply in the thread with a custom answer.
• Interruptions: If you send a follow-up message while the agent is still working, it stops the current task and starts on the new one.
• Completion: When the agent finishes, it posts a summary with a link to the pull request and a link to open the changes in the web editor.

Best practices

• Be specific: Tell the agent exactly what you want documented and where it should go.
• Add context: If a thread doesn’t contain all the necessary information, include additional details in your message to the agent.
• Review carefully: You should always review pull requests that the agent creates before merging them.