Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Mintlify includes predefined workflows for the most common documentation maintenance tasks. Each workflow has a base prompt and a default configuration. You can customize the trigger, update mode, and instructions from the Workflows page in your dashboard.

Self-updating content workflows

Self-updating content workflows make updates based on context that you define so your content remains accurate and up to date.

Update from code changes

Monitors your source code repositories and opens pull requests to update content for changes that affect users. You can run this workflow on a schedule, which generally uses fewer credits, or on every source code pull request. By default, the workflow runs on a weekly schedule. When you run the workflow on a schedule, the agent reads all merged source code pull requests since the last time the workflow ran. It groups related changes that require content updates into a pull request in your Mintlify project repository. If there are any unmerged pull requests from previous runs, the agent adds relevant changes to existing pull requests. The agent cites where the changes come from in your source code repositories. When you run the workflow on every source code pull request, the agent opens a content update pull request whenever you merge a code change that requires content updates. Use the push-based variant when you want content updates to appear as soon as code ships, rather than batched on a schedule.

Draft changelog

Creates a changelog entry on a recurring schedule. Add source code repositories as context so the agent has more detail about how your product changed. Without context repositories, the agent works from your content updates to write a changelog entry.

Draft improvements from assistant conversations

Reviews question trends from your assistant to identify gaps in your content, then opens a pull request to address them. The more assistant conversations your users have, the more signal the agent has to work with. Run this workflow on a recurring schedule to keep content aligned with what users want to know about your product.

Draft improvements from user feedback

Reviews page feedback—thumbs ratings and written comments—and updates content where users have reported problems. The agent focuses on pages with recurring negative signals rather than one-off feedback, so results improve as feedback accumulates. You must enable feedback collection on the Add-ons page before you can use this workflow.

Maintenance workflows

Maintenance workflows automate routine tasks to improve the quality and consistency of your content. You can run them on a content update trigger or on a recurring schedule. Running on a content update trigger maintains your content with minimal lag. Running on a schedule is generally more credit-efficient because the agent batches work across multiple changes in a single run. The tradeoff is a delay between when content changes and when the workflow acts on it. Any enabled maintenance workflows run on pull requests created by self-updating content workflows. If any changes are needed for the maintenance workflow, the agent combines the work into a single pull request. For example, if you enable the translate content workflow, the agent adds translations to any pull requests opened by the update from code changes workflow.

Translate content

Translates updated content into your selected target languages whenever changes push to your project repository. You must specify at least one target language. Mintlify reads the languages defined in your docs.json and preselects any already configured target languages. To disable translations for a language, remove all files in that language’s directory. You cannot disable translations for a language that still has published content. Finds and fixes broken internal and external links whenever content changes push to your project repository. Useful to run after major content reorganizations or when external services you reference change their URLs.

Audit SEO metadata

Audits and updates titles, meta descriptions, headings, and canonical tags whenever content changes. Add instructions to align the agent’s suggestions with your SEO strategy or target keywords.

Fix grammar & typos

Finds and fixes typos, spelling mistakes, and grammar errors whenever content changes. Add instructions to specify exceptions for technical terms, product names, or intentional stylistic choices that the agent should not change.

Apply style guide

Applies voice, tone, and writing rules to content whenever it changes. Add instructions to define the specific rules you want enforced or link to your style guide. The more precise your instructions, the more consistent the results.