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
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,9 @@ 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
+
## Configure the agent
23
+
24
+
### Add Agent to your Slack workspace
23
25
24
26
<Note>
25
27
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.
@@ -32,6 +34,10 @@ TODO: confirm steps
32
34
- Send a direct message to it.
33
35
- Mention it with `@mintlify` in a channel.
34
36
37
+
### Give the agent access to your repositories
38
+
39
+
TODO: once workflow is finalized
40
+
35
41
## Embed the agent via API
36
42
TODO: this whole section once the API is finalized
37
43
See the API reference for more info.
@@ -51,25 +57,25 @@ Use broad prompts for general content maintenance like fixing typos, updating re
51
57
The agent assists with many different documentation tasks. These workflows show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs.
52
58
53
59
### Iterate on a prompt in a Slack thread
54
-
You can prompt the agent, then continue to mention it with `@mintlify` in the same thread to refine and iterate on the pull request that it creates. For example: `@mintlify Our quickstart page needs a new section on inviting collaborators` then `@mintlify The new section should be called "Inviting collaborators"` and any other iterations.
60
+
Prompt the agent, then continue to mention it with `@mintlify` in the same thread to refine and iterate on the pull request that it creates. For example: `@mintlify Our quickstart page needs a new section on inviting collaborators` then `@mintlify The new section should be called "Inviting collaborators"` and any other iterations.
55
61
56
-
### Begin with the agent then take over in your local environment or the web editor
57
-
You can also query the agent to begin a project, then check out the branch it creates and finish the task in your local environment or the web editor. The agent can help you get started, then you can take over to complete the task. For example: `@mintlify Update the quickstart page to include information about inviting collaborators` and then checkout the branch to make any additional changes using your preferred method.
62
+
### Begin with the agent then take over
63
+
Prompt the agent to begin a project, then check out the branch it creates and finish the task in your local environment or the web editor. The agent can help you get started, then you can take over to complete the task. For example: `@mintlify Update the quickstart page to include information about inviting collaborators` and then checkout the branch to make any additional changes using your preferred method.
58
64
59
65
### Update docs when merging feature changes
60
-
When you merge a feature PR, mention the agent with the PR link to automatically update relevant documentation. For example: `@mintlify This PR adds a new authentication method. Update the API docs to include the new auth flow: [PR link]`.
66
+
When you merge a feature pull request, prompt the agent with a link to the pull request to automatically update relevant documentation. For example: `@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]`.
61
67
62
68
### Generate release notes from commit history
63
-
Mention the agent with a specific PR or a time period to generate release notes or changelog updates based on the commit history. For example: `@mintlify Generate release notes for this PR: [PR link]`.
69
+
Prompt the agent with a specific pull request or a time period to generate release notes or changelog updates based on the commit history. For example: `@mintlify Generate release notes for this PR: [PR link]` or `@mintlify Generate release notes for the last month`.
64
70
65
71
### Generate code examples
66
-
Generate code examples for features or endpoints. For example: `@mintlify Generate a code example to make the authentication method easier to understand`.
67
-
68
-
TODO: could be more specific about when/why this helps users
72
+
Prompt the agent to generate code examples for features throughout your docs or on specific pages. For example: `@mintlify Generate a code example to make the authentication method easier to understand`.
69
73
70
-
1. Add a workflow about reviewing existing content for accuracy: @mintlify Review the API rate limiting section - we changed limits last month
74
+
### Review existing content
75
+
Prompt the agent to review existing content for technical accuracy, style, grammar, or other issues. For example: `@mintlify Review the API rate limiting section. We changed limits last month`.
71
76
72
-
2. Consider adding troubleshooting prompts: @mintlify Users are getting confused by step 3 in the setup guide. Make it clearer
77
+
### Respond to user feedback
78
+
Prompt the agent with feedback from your users to make focused updates to your docs. For example: `@mintlify Users are getting confused by step 3 in the setup guide. Make it more clear`.
73
79
74
80
### Automate with the API
75
81
Integrate the agent into your existing automation tools to automatically update documentation when code changes occur, trigger content reviews, or sync documentation updates across multiple repositories.
0 commit comments