Mintlify agent use cases and examples

Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs.

The agent assists with many different documentation tasks. These examples 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.

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.

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 check out the branch to make any additional changes using your preferred method.

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].

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].

Share a pull request link with the agent to address reviewer comments and code review feedback on documentation pull requests.

For example: @mintlify Address the review comments on this PR: [PR link].

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.

Attach files or images directly to your Slack message when prompting the agent. The agent processes the attachment and includes it in the documentation. Supported attachments include images, PDFs, SVGs, and other documents.

For example: @mintlify Add this diagram to the architecture overview page with the image attached to the message.

The agent can view JPEG, PNG, GIF, and WebP images from your docs, connected repositories, and attachments. Prompt it to describe images, write alt text, or check whether screenshots still match the surrounding content.

For example: @mintlify Add descriptive alt text to every image on the quickstart page.

On deployments that require authentication, the agent only views images that appear on published pages it has read.

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.

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?.

Create automations to automate recurring tasks and reactive maintenance tasks like writing changelogs or updating content when you add new features to your product.

See Automations overview for more information.

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 job status, and send messages.

When creating jobs via the API, you can control whether pull requests open in draft mode using the asDraft parameter (defaults to false). Set asDraft: true to create draft pull requests, or keep the default to create non-draft pull requests ready for immediate review and merging in automated workflows.

• Examples
• Mintlify REST API introduction
• Assistant