Skip to content
Merged
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 @@ -26,7 +26,7 @@ Use the agent to:
- Search and revise code examples and API references across your docs.
- Reference source code from any repository that has the Mintlify GitHub App installed.
- Pull live context from connected apps like Slack, Notion, Linear, and Jira.
- 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 automate recurring tasks and reactive maintenance tasks like writing changelogs or updating content when you add new features to your product.

See [Workflows overview](/workflows/index) for more information.
See [Automations overview](/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,15 +17,15 @@

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.

### Discovering

Your site is automatically optimized for AI tools and search engines to help users discover your documentation. All pages send their content as Markdown to AI agents instead of HTML, which helps these tools process your content faster and use fewer tokens. Every page is also available to view as Markdown by appending `.md` to the URL. Use the [visibility](/components/visibility) component to tailor content for each audience.

Check warning on line 26 in ai-native.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai-native.mdx#L26

Use 'AGENTS' instead of 'agents'.

Mintlify hosts `llms.txt` and `skill.md` files for your documentation. These industry-standard files help LLMs respond efficiently with relevant information to user queries and provide a list of capabilities for agents to use, so that users are more successful with your product.

Check warning on line 28 in ai-native.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai-native.mdx#L28

Use 'AGENTS' instead of 'agents'.

<Tip>
Teach your users how to install your `skill.md` file so they get better results when using your product with AI tools. Embed an installation prompt directly in your docs with the [`Prompt` component](/components/prompt):
Expand All @@ -49,7 +49,7 @@
<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
2 changes: 1 addition & 1 deletion assistant/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ boost: 3
---

<Info>
The assistant is on by default. All organizations receive 5,000 trial credits shared across the assistant, agent, and workflows. See [Manage billing](/assistant/configure#manage-billing) for more information about credit tiers and options.
The assistant is on by default. All organizations receive 5,000 trial credits shared across the assistant, agent, and automations. See [Manage billing](/assistant/configure#manage-billing) for more information about credit tiers and options.
</Info>

## About the assistant
Expand Down
48 changes: 48 additions & 0 deletions automations/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
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", "custom automation"]
---

import GitlabAutomationSetup from '/snippets/gitlab-automation-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. It 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, trigger, instructions, context repositories, integrations, and update mode.
4. Click **Create automation**.

## Write effective instructions

Effective automation instructions focus on a single task and define a clear, verifiable outcome. Automations have some variance because agents are nondeterministic, but well-formatted instructions produce more 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'.

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 'AGENTS' instead of 'agents'.

- **Describe the outcome.** Tell the agent what a successful run should look like.
- **Write a procedure.** Give the agent a step-by-step guide to follow.
- **Keep scope narrow.** Split complex tasks across multiple automations rather than combining them into one prompt.

For more examples and patterns, see [Use automations](/guides/use-automations).

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

<GitlabAutomationSetup />

## 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**.
50 changes: 50 additions & 0 deletions automations/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
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 content 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 changes in 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 reads your project content and any connected repositories, then follows the prompt to make updates.

<Tip>
Use automations that run on a schedule for recurring tasks, like publishing changelogs or auditing SEO metadata.

Use automations that trigger on content or code changes for reactive maintenance, like translations or updating content when source code changes.
</Tip>

## Trigger types

Automations support three 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'.

- **Content update**: Run when content changes push to your Mintlify project repository, including pull request merges and direct pushes.
- **Code change**: Run when a pull request merges in a connected source code repository.
- **Custom schedule**: Run on a recurring schedule. Automations queue within 10 minutes of the scheduled time.

Check warning on line 25 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L25

Use 'automations?' instead of 'Automations'.

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

## Usage limits

Automation runs count toward your credit usage. See your credit usage, set overages, and manage your credit package on the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard.

Check warning on line 31 in automations/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/index.mdx#L31

Use 'automations?' instead of 'Automation'.

Each automation can run up to 500 times per day. Runs that fail do not count toward this limit.

## Next steps

<CardGroup cols={2}>
<Card title="Predefined automations" icon="list" href="/automations/reference">
Reference for all predefined automations: triggers, update modes, and required configuration.
</Card>
<Card title="Manage automations" icon="toggle-right" href="/automations/manage">
Turn on predefined automations and configure triggers, update mode, and context.
</Card>
<Card title="Create a custom automation" icon="plus" href="/automations/create">
Build an automation with your own trigger, instructions, and context repositories.
</Card>
<Card title="Learn best practices" icon="book-open" href="/guides/use-automations">
Choose the right trigger, write effective instructions, and review results.
</Card>
</CardGroup>
124 changes: 124 additions & 0 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
---
title: "Manage automations"
description: "Enable, disable, trigger, and delete automations from your dashboard. Configure GitHub or GitLab triggers, schedules, context repos, and automerge."
keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"]
---

import GitlabAutomationSetup from '/snippets/gitlab-automation-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)

<Tip>
You can also create, list, and delete automations from the terminal with [`mint automation`](/cli/commands#mint-automation). The CLI is useful for scripting and CI; the dashboard is the easiest way to configure and monitor automation runs.
</Tip>

## Enable an automation

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 panel opens so you can fill in any required configurations.
<Frame>
<img src="/images/workflows/workflow-settings-light.png" alt="The configuration options for an automation." className="block dark:hidden" />
<img src="/images/workflows/workflow-settings-dark.png" alt="The configuration options for an automation." className="hidden dark:block" />
</Frame>
3. If the settings panel opens, fill in the required fields.
4. 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

Each automation has a default trigger that controls when it runs. To change the trigger, select a different option in the settings panel.

- **Content update**: Runs whenever you push content to your project repository, including pull request merges and direct pushes.
- **Code change**: Runs when a pull request merges in a connected source code repository. You must specify at least one source repository.
- **Custom schedule**: Runs on a recurring schedule you define. Automations queue within 10 minutes of the scheduled time.

Check warning on line 46 in automations/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/manage.mdx#L46

Use 'automations?' instead of 'Automations'.

### Update mode

Each automation has a default mode for how it makes updates. Either directly merging changes into your content repository or opening a pull request for review.

To require a review before the automation updates your content, select **Require review** in the settings panel.

<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>

### Context repositories

For custom automations and some predefined automations, you can add context repositories—additional source code repositories the agent reads when the automation runs. This is useful when your automation prompt references code, APIs, or other content that lives outside your project repository.

You can add up to 10 context repositories per automation. For each GitHub repository, install the Mintlify GitHub App. Add repositories on the [GitHub App settings](https://app.mintlify.com/settings/organization/github-app) page.

### Integrations

For custom automations and the **Update from code changes** automation, you can enable connected [agent integrations](/agent/integrations) so the agent can pull context from tools like Slack, Notion, or Linear when the automation runs.

To enable integrations for an automation, open its settings and select the integrations you want the agent to use in the **Available integrations** section. Only integrations already connected for your organization appear in the list. See [Agent integrations](/agent/integrations) for more information on connecting integrations.

### Slack notifications

Send Slack messages to one or more channels when automations run.

To enable Slack notifications:
1. Install the [Mintlify Slack app](/agent/slack) in your workspace.
2. Click **Turn on Slack notifications** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard.
<Frame>
<img src="/images/workflows/turn-on-slack-notifications-light.png" alt="The turn on Slack notifications button." className="block dark:hidden" />
<img src="/images/workflows/turn-on-slack-notifications-dark.png" alt="The turn on Slack notifications button." className="hidden dark:block" />
</Frame>
3. Select one or more notification channels.
4. Click **Save changes**.

Once enabled, Mintlify posts to the selected channels when:

- An automation opens a pull request for review.
- An automation pull request has been waiting for review for three days.
- An automation merges a pull request, or fails to complete.

### Instructions

Add optional instructions that append to the automation's base prompt on every run. Use these to adjust the style, tone, or other project-specific behaviors without changing the core automation logic.

### Target languages

When you enable the **Translate content** automation, select one or more languages 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 add target languages at any time by opening the automation's settings and editing the **Translate to** field.

<GitlabAutomationSetup />

## 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 or change its schedule, Mintlify recalculates the next run time from the current time. Disabled automations do not retain a pending run time.

## View run history

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

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