Skip to content
Open
Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Use the agent to:
- Process and include images, diagrams, and other files from Slack attachments.
- Search and revise code examples and API references across your docs.
- Reference source code from any repository that has the Mintlify GitHub App installed.
- Automate documentation maintenance with workflows.
- Automate documentation maintenance with automations.
- Answer questions about your docs and technical writing topics.
- Address code review feedback to maintain documentation quality.
- Capture knowledge from Slack conversations and pull requests before it gets lost.
Expand Down Expand Up @@ -62,6 +62,6 @@ Configure the agent with an `AGENTS.md` file.
<Card title="Write effective prompts" horizontal icon="pen" href="/agent/effective-prompts">
Get better results with focused prompts.
</Card>
<Card title="Automate with workflows" horizontal icon="refresh-cw" href="/workflows/index">
Automate recurring tasks and documentation maintenance with workflows.
<Card title="Automate with automations" horizontal icon="refresh-cw" href="/automations/index">
Automate recurring tasks and documentation maintenance with automations.
</Card>
8 changes: 4 additions & 4 deletions agent/use-cases.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Use cases"
description: "Explore real-world examples of using the Mintlify agent to automate documentation updates, capture knowledge, and maintain accurate docs."
keywords: ["agent workflows", "documentation workflows", "automation examples"]
keywords: ["agent automations", "documentation automations", "automation examples"]
---

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.
Expand Down Expand Up @@ -60,11 +60,11 @@ Prompt the agent with feedback from your users to make focused updates to your d

For example: `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`.

## Automate with workflows
## Automate with automations

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

See [Workflows](/workflows/index) for more information.
See [Automations](/automations/index) for more information.

## Automate with the API

Expand Down
4 changes: 2 additions & 2 deletions ai-native.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In addition to reading individual pages, users can chat with the [assistant](/as

The [agent](/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your documentation by chatting with the agent. Or embed the agent into custom apps via the [API](/api/agent/v2/create-agent-job).

Create [workflows](/workflows/index) to run the agent on a schedule or on a push to a repository. Each workflow defines a prompt for the agent and a trigger for when to run it.
Create [automations](/automations/index) to run the agent on a schedule or on a push to a repository. Each automation defines a prompt for the agent and a trigger for when to run it.

Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/claude-code), and [Windsurf](/guides/windsurf) to reference the Mintlify schema, your style guide, and best practices.

Expand Down Expand Up @@ -49,7 +49,7 @@ Select any of the following cards for more information.
<Card title="Assistant" icon="bot-message-square" href="/assistant/configure">
Configure the assistant to search external sites or direct people to your support team if it can't answer their questions.
</Card>
<Card title="Workflows" icon="message-circle-plus" href="/workflows/index">
<Card title="Automations" icon="message-circle-plus" href="/automations/index">
Get documentation updates automatically on a schedule or when a push event occurs.
</Card>
<Card title="Contextual menu" icon="sparkles" href="/ai/contextual-menu">
Expand Down
39 changes: 39 additions & 0 deletions automations/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "Create a custom automation"
description: "Create a custom Mintlify automation with a schedule or push trigger, context repositories, and an agent prompt to automate recurring documentation tasks."
keywords: ["automation", "automate", "cron", "agent"]
---

import GitlabWorkflowSetup from '/snippets/gitlab-workflow-setup.mdx';

## Prerequisites

- A Mintlify project connected to a GitHub or GitLab repository
- For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the automation
- For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below)

## Create a custom automation

<Note>
The agent runs in an isolated sandbox with restricted internet access. The agent cannot install additional packages or tools at runtime. Prompts that reference unavailable tools may produce unexpected results or fail.
</Note>

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click **Create a custom automation**.
3. Configure the automation name, when it runs, instructions, and how it makes updates.
4. Click **Create automation**.

## Best practices

Effective automation instructions focus on a single task and define a clear, verifiable outcome. Automations have some variance because agents are nondeterministic, but consistent instructions produce consistent results.

Check warning on line 28 in automations/create.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/create.mdx#L28

Use 'automations?' instead of 'Automations'.

- **Describe the outcome.** Tell the agent what the result should look like. Describe what done looks like.
- **Write a procedure.** Give the agent a step-by-step guide to follow.
- **Specify context.** Reference the files, directories, or repositories the agent should use.
- **Keep scope narrow.** Split complex tasks across multiple automations rather than combining them into one prompt.

<Tip>
Review the output of your custom automations to ensure they are working as expected. Update your instructions to improve the results.
</Tip>

<GitlabWorkflowSetup />
95 changes: 95 additions & 0 deletions automations/enable.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
title: "Enable automations"
description: "Enable automations on your Mintlify project. Configure GitHub or GitLab triggers, add context repositories, set schedules, and turn on automerge for the agent."
keywords: ["cron", "push trigger", "automerge"]
---

import GitlabWorkflowSetup from '/snippets/gitlab-workflow-setup.mdx';

## Prerequisites

- A Mintlify project connected to a GitHub or GitLab repository
- For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the automation
- For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below)

## Enable automations

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the toggle beside an automation to enable it.
<Frame>
<img src="/images/workflows/workflows-dashboard-light.png" alt="The automations dashboard." className="block dark:hidden" />
<img src="/images/workflows/workflows-dashboard-dark.png" alt="The automations dashboard." className="hidden dark:block" />
</Frame>

If the automation can run with default settings, it activates immediately. Otherwise, the settings modal opens so you can choose any required configurations.
<Frame>
<img src="/images/workflows/workflow-settings-light.png" alt="The configuration options for the codebase updates automation." className="block dark:hidden" />
<img src="/images/workflows/workflow-settings-dark.png" alt="The configuration options for the codebase updates automation." className="hidden dark:block" />
</Frame>
3. If the modal opens, fill in the required fields and click **Turn on automation**.

To change settings for an active automation, click the <Icon icon="settings" /> settings button beside it. Use the toggle in the modal header to enable or disable the automation without leaving the settings view.

## Configurations

### Trigger repositories

For automations that run on push events, specify the repositories to watch. You can specify up to 10 repositories per automation.

For GitHub repositories, you must install the Mintlify GitHub App on each repository. Add repositories on the [GitHub app](https://app.mintlify.com/settings/organization/github-app) settings page.

### Update mode

Each automation has a default mode for how it makes updates, either by directly updating your content repository or by opening a pull request.

If you want to require reviews before an automation updates your content, click **Require review**.

<Note>
For GitHub repositories, automatic updates require the Mintlify GitHub App to have bypass permissions on every ruleset targeting your deploy branch, including organization-level and repository-level rulesets. See [Configure automerge](/guides/configure-automerge) for setup instructions.

For GitLab repositories, automerge uses the GitLab OAuth connection and requires at least the Maintainer role on each project.
</Note>

### Trigger

Each automation has a default for when it runs, either in response to changes in your content repository, in response to changes in a trigger repository, or on a schedule.

If you want to change the default, select a different trigger.

### Instructions

Add optional instructions appended to the automation's base prompt. Use these instructions to adjust the style, tone, or other aspects unique to your project.

### Target languages

When you enable the **Translate content** automation, select one or more languages you want to keep in sync with your source content.

- Mintlify reads the [languages](/organize/navigation#languages) defined in your `docs.json` to identify your default language and preselects any already configured target languages.
- You must select at least one target language to save the automation.
- You cannot select the source language as a target.

You can change the target languages at any time by opening the automation's settings and editing the **Translate to** field.

#### Run a translation immediately

After saving the automation, click **Translate now** to run it on demand using the currently saved target languages. The automation must be enabled to trigger a manual run. Manual runs do not affect the automation's regular trigger.

Check warning on line 75 in automations/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/enable.mdx#L75

In general, use active voice instead of passive voice ('be enabled').

## Improve docs from assistant chats

The **Improve docs from assistant chats** automation reviews recent trends in [assistant](/assistant/index) questions and opens targeted documentation updates that address gaps your users hit.

Use this automation when you want the agent to triage assistant activity for you and propose changes that answer the questions users actually ask.

This automation runs on a schedule. It does not require trigger repositories or extra context configuration. Enable it from the [Automations](https://app.mintlify.com/products/automations) page and pick whether updates merge automatically or open a pull request for review.

## Improve docs from feedback

The **Improve docs from feedback** automation reviews recent [page feedback](/optimize/feedback) and opens targeted documentation updates based on the issues users report.

Use this automation when you collect thumbs ratings or contextual feedback and want the agent to convert that signal into concrete docs changes.

When a run completes, the run detail in your dashboard includes the specific feedback citations the agent used. Each citation links to the feedback in your [analytics dashboard](https://app.mintlify.com/products/analytics/v2/feedback) so you can verify the context that drove the update.

This automation runs on a schedule and requires that feedback collection is enabled on the [Add-ons](https://app.mintlify.com/products/addons) page. It does not require trigger repositories or extra context configuration.

Check warning on line 93 in automations/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/enable.mdx#L93

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

<GitlabWorkflowSetup />
30 changes: 30 additions & 0 deletions automations/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Automations overview"

Check warning on line 2 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L2

Use 'automations?' instead of 'Automations'.
sidebarTitle: "Overview"
description: "Automate documentation maintenance with Mintlify automations. Run the agent on a schedule or in response to GitHub and GitLab repository pushes."
keywords: ["automation", "automate", "cron", "agent", "automations"]
boost: 5
---

Automations run the agent automatically on a schedule or in response to pushes to a repository. Each automation defines a prompt for the agent and a trigger for when to run it. Automations support both GitHub and GitLab repositories.

Check warning on line 9 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L9

Use 'automations?' instead of 'Automations'.

Check warning on line 9 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L9

Use 'automations?' instead of 'Automations'.

When an automation runs, the agent clones any specified repositories as context and follows the prompt.

<Tip>
Use automations that run on a schedule to automate recurring tasks, like publishing changelogs or checking for grammar and style issues.

Use automations that run on push events to automate reactive maintenance tasks, like updating API reference documentation or identifying documentation updates needed for new features.
</Tip>

## Trigger types

Automations support two trigger types.

Check warning on line 21 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L21

Use 'automations?' instead of 'Automations'.

- **Schedule (cron)** — Run on a recurring daily, weekly, or monthly schedule. Automations queue within 10 minutes of the scheduled time.

Check warning on line 23 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L23

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

Check warning on line 23 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L23

Use 'automations?' instead of 'Automations'.
- **Push events** — Run when changes push to a specific repository or branch, including pull request merges and direct pushes.

Check warning on line 24 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L24

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

You cannot combine trigger types in a single automation. Each automation has exactly one trigger.

## Usage limits

Each automation can run up to 500 times per day. Hobby plan projects have an additional limit of 100 total automation runs per month. Runs that fail do not count towards these limits.
32 changes: 32 additions & 0 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Manage automations"
description: "Trigger, disable, re-enable, and delete Mintlify automations from your dashboard, and learn how schedules recalculate after you pause and resume an automation."
keywords: ["manage automations", "trigger automation", "disable automation", "enable automation"]
---

## Disable an automation

1. Go to the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the toggle beside an automation to disable it.

When you re-enable a scheduled automation, Mintlify recalculates the next run time from the current time.

## Delete a custom automation

Deleting an automation is permanent and removes its configuration and run history.

1. Go to the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="settings" /> settings button beside an automation.
3. Click **Delete**.

## View run history

Each automation keeps a log of past runs, including the status and a summary of changes made.

1. Go to the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click an automation.
3. Use the dropdown menus to filter by specific automations or status.
<Frame>
<img src="/images/workflows/workflow-runs-light.png" alt="Automation runs with the status filter menu open." className="block dark:hidden" />
<img src="/images/workflows/workflow-runs-dark.png" alt="Automation runs with the status filter menu open." className="hidden dark:block" />
</Frame>
Loading