You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ai/agent.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,12 @@ title: "Agent"
3
3
description: "The agent helps you write and maintain documentation"
4
4
icon: "pen-line"
5
5
---
6
-
TODO: finalize naming
6
+
7
7
<Info>
8
-
Agent is available to anyone with access to your dashboard.
8
+
The agent is available to anyone with access to your dashboard.
9
9
</Info>
10
10
11
-
Agent helps you write and maintain documentation. It can reference your documentation, GitHub repositories that you give it access to, pull requests, Slack messages, the Mintlify schema, and technical writing best practices. The agent integrates with your Slack workspace and can be embedded in custom applications with the API.
11
+
The agent helps write and maintain your documentation. 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.
12
12
13
13
Use the agent to:
14
14
@@ -19,22 +19,22 @@ Use the agent to:
19
19
20
20
To get started, add the agent to your Slack workspace and mention it with `@mintlify` in a channel.
21
21
22
-
## Add Agent to your Slack workspace
22
+
## Add the agent to your Slack workspace
23
23
24
24
<Note>
25
-
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the TODO: (confirm app name) MintlifyWriter app before you add it.
25
+
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the mintlify app before you connect it.
26
26
</Note>
27
-
TODO: confirm steps
27
+
28
28
1. Navigate to the [agent](https://dashboard.mintlify.com/products/agent) page of your dashboard.
29
-
2. Select **Connect**in the Slack card.
30
-
3. Follow the Slack prompts to add the app to your workspace.
29
+
2. Select the **Connect**button.
30
+
3. Follow the Slack prompts to add the `mintlify`app to your workspace.
31
31
4. Test that the agent is working and responds when you:
32
32
- Send a direct message to it.
33
33
- Mention it with `@mintlify` in a channel.
34
34
35
35
## Connect repositories as context
36
-
TODO: revisit when UI is finalized
37
-
The agent can only access GitHub repositories that you grant it access to. You can modify which repositories the agent can access in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).
36
+
37
+
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).
38
38
39
39
## Embed the agent via API
40
40
TODO: this whole section once the API is finalized
0 commit comments