Skip to main content
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". Followed by 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, share the PR link with the agent to update relevant docs. 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 a pull request

Prompt the agent with a specific pull request to generate release notes or changelog updates based on the commit history. For example: @mintlify Generate release notes for this PR: [PR link].

​
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. Use the agent endpoints to create jobs, get a specific job, and get all jobs. When creating jobs via the API, you can control whether pull requests open in draft mode using the asDraft parameter (defaults to true). Set asDraft: false to create non-draft pull requests ready for immediate review and merging in automated workflows. Learn how to set up API automation in the Auto-update documentation when code is merged tutorial.