-
Notifications
You must be signed in to change notification settings - Fork 207
Agent docs #1351
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.
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
Agent docs #1351
Changes from 16 commits
Commits
Show all changes
29 commits
Select commit
Hold shift + click to select a range
74388a6
update Slack app naming
ethanpalm a8bae3f
add agent page to nav
ethanpalm ca565ad
create agent page
ethanpalm d350e42
add to common workflows
ethanpalm 37bbbd0
remove passive voice
ethanpalm 9cc8904
add API workflow example
ethanpalm 6e1220d
add Slack to header exceptions
ethanpalm 8b2616b
revise intro
ethanpalm bff8349
adjust header depth for ToC
ethanpalm 4d74950
clean up the prompts section
ethanpalm e1cc77f
add into to workflows section
ethanpalm 32b5ac6
add broad examples
ethanpalm b0052b3
update example workflows
ethanpalm 1d92a46
💅
ethanpalm 2759113
add steps for connecting repos
ethanpalm ab0adc1
clean up some TODOs
ethanpalm 89efe28
edit intro
ethanpalm a58beb0
Merge branch 'main' into agent-docs
ethanpalm 5c0eb5f
feature: rough draft of discovery agent routes. Copy is prone to chan…
cdxker bb8b439
feature: finalized rough draft of api spec. Cleaned up copy on the ap…
cdxker 44a4de7
alphabetize endpoint groups
ethanpalm 1b29f2c
writer -> agent
ethanpalm 4159fb3
add links to endpoint pages
ethanpalm 9184563
💅
ethanpalm ef4807f
add rate limit info
ethanpalm 97aef0f
spacing
ethanpalm b7d24df
update availability
ethanpalm db3b557
concision
ethanpalm c6a2c0e
update access requirements
ethanpalm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,6 +30,7 @@ exceptions: | |
- SAML | ||
- SDK | ||
- Slack | ||
- SSL | ||
- SSO | ||
- TLS | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
--- | ||
title: "Agent" | ||
description: "The agent helps you write and maintain documentation" | ||
icon: "pen-line" | ||
--- | ||
|
||
<Info> | ||
The agent is available to anyone with access to your dashboard. | ||
</Info> | ||
|
||
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. | ||
|
||
Use the agent to: | ||
|
||
- Write new content based on your prompts, links to pull requests, or Slack threads | ||
- Revise outdated code examples and API references | ||
- 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. | ||
|
||
## Add the agent to your Slack workspace | ||
|
||
<Note> | ||
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the mintlify app before you connect it. | ||
</Note> | ||
|
||
1. Navigate to the [agent](https://dashboard.mintlify.com/products/agent) page of your dashboard. | ||
2. Select the **Connect** button. | ||
3. Follow the Slack prompts to add the `mintlify` app to your workspace. | ||
4. Test that the agent is working and responds when you: | ||
- Send a direct message to it. | ||
- Mention it with `@mintlify` in a channel. | ||
|
||
## 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). | ||
|
||
## Embed the agent via API | ||
TODO: this whole section once the API is finalized | ||
See the API reference for more info. | ||
|
||
## Write effective prompts | ||
|
||
Think of the agent as a helpful assistant that needs your guidance to complete tasks. If you give it clear instructions and context, it is more likely to complete the task successfully. More focused tasks are easier to complete, so break down complex projects into smaller steps. | ||
|
||
Make your prompts specific and outcome-focused. A prompt like `@mintlify Improve the onboarding page` will have the agent apply general technical writing best practices to the page, but it may not improve the page in a way that truly helps your users. | ||
|
||
Try prompts based on outcomes you want your users to achieve or problems that you know they encounter. For example: `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` or `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key`. | ||
|
||
Use broad prompts for general content maintenance like fixing typos, updating redirects, or renaming a feature throughout your docs. For example: `@mintlify Find and fix all typos in the docs` or `@mintlify change all unordered lists to use * instead of -`. | ||
|
||
## Agent workflows | ||
|
||
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. | ||
|
||
### Iterate on a prompt in a Slack thread | ||
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. | ||
|
||
### Start with the agent, finish manually | ||
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. | ||
|
||
### Update docs when merging feature changes | ||
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]`. | ||
|
||
### Generate release notes from commit history | ||
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`. | ||
|
||
### Generate code examples | ||
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`. | ||
|
||
### Review existing content | ||
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`. | ||
|
||
### Respond to user feedback | ||
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. What might be making it unclear?`. | ||
|
||
### Automate with the API | ||
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.