Mintlify integration guide
How to keep Mintlify up to date
Find the pages in your Mintlify documentation that one of your merged code changes made wrong, before readers and the Mintlify assistant repeat them.
Keeping help centers accurate at
The short answer
- What Mintlify offers
- Your Mintlify docs come with features like the Update from code changes automation, which opens pull requests for merged code, plus the agent, preview deployments and Analytics.
- Where it stops
- Those features start from a merged pull request, a schedule or a reader's rating, and none of them has a documented view of whether a feature flag has switched the change on.
- Where Solo fits
- Solo reads your code changes and your docs repository, flags the pages a change made wrong, and drafts fixes that open as pull requests a person reviews and merges.
On this pageShort answer
Why it matters
Why an accurate docs site matters
You merge a feature on Tuesday, the docs describe the old behavior until a reader complains, and by then the assistant has already answered from the old page. Readers can't self-serve, the assistant repeats stale steps, and public pages give the wrong answer in search.
Readers solve problems without asking you
A page that matches your product lets a developer finish the task and move on. A wrong one sends them to your support team, and the thumbs-down rating that Mintlify collects arrives only after the page has misled them.
The Mintlify assistant answers correctly
The assistant answers from your published documentation and links to the pages it used, so a stale page is quoted back to readers as fact. On Pro and Enterprise, each answered question uses 25 credits, so a wrong answer costs money as well as trust.
Public pages show up correctly in search
Search engines and AI answer engines quote public documentation, and Mintlify analytics reports agent traffic alongside human visits. A wrong page gets read by both before anyone files a ticket.
Built-in tools
Maintaining docs with the Mintlify agent and Mintlify workflows
Mintlify has real tools for this, including an agent and an automation that read merged pull requests from connected repositories and open docs pull requests. They act at merge time or on a schedule, and nothing in them shows whether a feature flag has switched the change on for customers.
| Stage | Mintlify's features | Missing features |
|---|---|---|
| 01Know upcoming changes | The Update from code changes automation, on Pro and Enterprise, reviews pull requests merged in your connected source code repositories, either every merged pull request or on a schedule. The agent can also read any repository where the Mintlify GitHub App is installed. | Both react once a pull request has merged, and Mintlify's docs describe no feature flag status. A change that merges behind a flag can produce docs for something customers can't use yet. |
| 02Identify outdated articles | Analytics lists poorly rated pages in the Feedback view and frequent queries in the Search view, the Fill gaps from assistant conversations automation reviews assistant question trends, and mint broken-links finds broken links from the command line. | Ratings, assistant questions and broken links point to readers who struggled or to links that fail, not to instructions that no longer match your product. An agent review of existing content only runs when someone asks for it. |
| 03Draft updated copy | The agent writes updates with citations to the source code and can check whether screenshots still match their surrounding content. It runs Mintlify CLI checks on its work before it opens a pull request. | It drafts from the pull request or prompt it is given, so a page affected by something else is outside its view. The CLI checks confirm the docs build, not that the instructions are correct. |
| 04Collaborate on updates | Automation pull requests assign reviewers from the authors of the triggering code changes on GitHub, preview deployments show the rendered pages, and the web editor offers branches with Request review. | Reviewers see a diff and a preview, but not the feature flag status or a way to hold a change until the flag turns on. |
| 05Publish changes | Merging a pull request into the deployment branch set in Git Settings deploys the site, and Merge and publish in the web editor does the same. A project hosted by Mintlify has the agent commit straight to the deployment branch. | Publishing follows a merge, not an event in your product. Nothing holds a docs change until the feature it describes is on. |
With Solo
Mintlify docs maintenance with Solo on top
Mintlify's agent can read merged code, but it acts when a trigger fires or someone sends a request. Solo reads recent changes across your connected code repositories, compares them with the pages in your docs repository, and flags the pages a change made wrong. It drafts the fix as a pull request, and a person reviews and merges it.
What Solo adds to Mintlify's built-in tools
| Stage | Mintlify without Solo | Mintlify with Solo |
|---|---|---|
| 01Know upcoming changes | The Update from code changes automation, on Pro and Enterprise, reviews pull requests merged in your connected source code repositories, either every merged pull request or on a schedule. The agent can also read any repository where the Mintlify GitHub App is installed. | Solo reads recent changes in your connected code repositories and shows the feature flag and its rollout status on a review item when that status is available. |
| 02Identify outdated articles | Analytics lists poorly rated pages in the Feedback view and frequent queries in the Search view, the Fill gaps from assistant conversations automation reviews assistant question trends, and mint broken-links finds broken links from the command line. | Solo compares each change summary with the pages in your docs repository and flags the ones that are confidently wrong, with the triggering sources attached. |
| 03Draft updated copy | The agent writes updates with citations to the source code and can check whether screenshots still match their surrounding content. It runs Mintlify CLI checks on its work before it opens a pull request. | Solo proposes the old and new text for each flagged page, and can flag an image that may no longer match or suggest adding a section. |
| 04Collaborate on updates | Automation pull requests assign reviewers from the authors of the triggering code changes on GitHub, preview deployments show the rendered pages, and the web editor offers branches with Request review. | Each suggestion opens as a review item where your team can edit it, accept it, add it to a draft, reject it, snooze it until a flag changes, or mark it resolved elsewhere. |
| 05Publish changes | Merging a pull request into the deployment branch set in Git Settings deploys the site, and Merge and publish in the web editor does the same. A project hosted by Mintlify has the agent commit straight to the deployment branch. | Accepting a suggestion opens a pull request in your docs repository, or updates an open one. Solo doesn't merge it, and merging is what updates your Mintlify site. |
Questions
Questions about Mintlify and Solo
What Mintlify teams usually ask before connecting Solo to their docs repository.
Does Solo replace anything in Mintlify?
No. Your pages, your docs.json settings and the Mintlify agent stay as they are. Solo suggests changes, and approved ones open as pull requests against your docs repository for a person to review and merge.
Mintlify already has an automation for code changes. How is Solo different?
Update from code changes reviews merged pull requests and opens docs pull requests with citations. Solo adds a review step built around the existing page, where each item shows the old and proposed text with its triggering sources, and it can show feature flag status and snooze a suggestion until a flag changes. You can use both.
Can Mintlify workflows update docs after a code change?
Yes, on a Pro or Enterprise plan. An automation with the Code change trigger runs when a pull request merges in a connected source code repository, and it opens a pull request with the docs updates. Each run that updates docs uses 250 credits.
Does Mintlify analytics show which pages are wrong?
It shows which pages readers rate poorly. The Feedback view lists page ratings and written comments, and the Search view lists frequent queries, both on Pro and Enterprise. Neither shows which sentence stopped matching your product.
How does Solo connect to Mintlify, and what happens when I accept a change?
Solo connects to the GitHub repository that holds your docs. Accepting a suggestion creates a branch and a pull request, or updates an open one on a named branch, and Solo doesn't merge it. When your team merges, Mintlify deploys the site, which usually takes 30 seconds to a few minutes.
Will Solo change Mintlify pages without a review?
No. Each suggestion waits for someone on your team to accept, edit, snooze or reject it. Even an accepted change is only a pull request until a person merges it.
Related guides
Also works with
Solo works with the docs and help center platforms you already run, and each guide covers what is specific to that platform.
Further reading on help center drift
Self-Updating Help Center: How It Actually Works
A self-updating help center catches product changes before customers do. Here's what "automatic" really means, and what still needs a human.
4 min read
Release Notes to Help Center Articles With AI: What Works
Piping release notes into AI for instant help articles sounds efficient, but it misses the real problem. Here's what keeps a help center accurate instead.
4 min read
When to Update Help Center Articles: A Practical Threshold
A calendar-based review cadence misses most drift. Here's a practical threshold for when a help center article actually needs updating, and why it matters.
7 min read
See which Mintlify pages your code changes broke
A demo runs Solo against your own codebase and Mintlify docs repository, so you see which pages are wrong today.