Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion workflows/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,26 @@

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.

Check warning on line 22 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L22

Don't put a space before or after a dash.
- **Push events** — Run when changes push to a specific repository or branch, including pull request merges and direct pushes.

Check warning on line 23 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L23

Don't put a space before or after a dash.

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.

Check warning on line 33 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L33

Don't put a space before or after a dash.
- **Writing style** — Enforce consistent voice, tone, and formatting.

Check warning on line 34 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L34

Don't put a space before or after a dash.
- **Typo check** — Catch spelling, grammar, and broken markdown.

Check warning on line 35 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L35

Don't put a space before or after a dash.

Check warning on line 35 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L35

Use 'Markdown' instead of 'markdown'.
- **Broken link detection** — Find and fix links that don't resolve.

Check warning on line 36 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L36

Don't put a space before or after a dash.
- **SEO metadata audit** — Check titles and descriptions for length and uniqueness.

Check warning on line 37 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L37

Don't put a space before or after a dash.

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.

Check warning on line 39 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L39

In general, use active voice instead of passive voice ('is finalized').

Check warning on line 39 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L39

Don't put a space before or after a dash.

Check warning on line 39 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L39

Don't put a space before or after a dash.

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.

Check warning on line 41 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L41

Use semicolons judiciously.

## Usage limits

Expand Down
Loading