From 63855343a6cb0bf33808d6766f798afd2fed348d Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 13 May 2026 02:17:39 +0000 Subject: [PATCH] Document maintenance follow-up behavior for workflow PRs Generated-By: mintlify-agent --- workflows/index.mdx | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/workflows/index.mdx b/workflows/index.mdx index ed1d0668c..aeb2dda73 100644 --- a/workflows/index.mdx +++ b/workflows/index.mdx @@ -22,7 +22,23 @@ Workflows support two trigger types. - **Schedule (cron)** — Run on a recurring daily, weekly, or monthly schedule. Workflows queue within 10 minutes of the scheduled time. - **Push events** — Run when changes push to a specific repository or branch, including pull request merges and direct pushes. -You cannot combine trigger types in a single workflow. Each workflow has exactly one trigger. +You cannot combine trigger types in a single workflow. Each workflow has exactly one trigger. + +## Maintenance follow-up + +Some workflow templates apply documentation best practices across your project. These run as a follow-up pass on pull requests opened by other workflows so that maintenance checks aren't skipped on bot-authored PRs. + +Maintenance workflow templates include: + +- **Translations** — Mirror prose changes into other configured languages. +- **Writing style** — Enforce consistent voice, tone, and formatting. +- **Typo check** — Catch spelling, grammar, and broken markdown. +- **Broken link detection** — Find and fix links that don't resolve. +- **SEO metadata audit** — Check titles and descriptions for length and uniqueness. + +When another workflow (for example, a changelog or feature docs workflow) opens a pull request, the agent applies every enabled maintenance workflow inline and pushes the fixes as additional commits to the same branch. The pull request is finalized — and [automerge](/workflows/enable#update-mode) runs, if enabled — only after the maintenance pass completes. + +To enable a maintenance pass, turn on the corresponding template from the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page. Maintenance workflows still run on their own trigger as usual; the follow-up behavior is additive. ## Usage limits