Manage automations

​

Prerequisites

• A Mintlify project connected to a GitHub or GitLab repository
• For GitHub: the Mintlify GitHub App installed on every repository you plan to use in the automation
• For GitLab: a connected GitLab account (see GitLab setup below)

​

Enable an automation

1. Open the Automations page in your dashboard.
2. Click the toggle beside an automation to enable it.
   
   If the automation can run with default settings, it activates immediately. Otherwise, the settings panel opens so you can fill in any required configurations.
   
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 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.

​

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.

​

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

​

Integrations

For custom automations and the Update from code changes automation, you can enable connected 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 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 in your workspace.
2. Click Turn on Slack notifications on the Automations page of your dashboard.
   
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 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.

​

GitLab setup

To use GitLab repositories in an automation, connect each project through the GitLab OAuth settings page. Connect every repository the automation touches—your documentation repository and any trigger or context repositories. You must have at least the Maintainer role on each project.

​

Disable an automation

1. Go to the 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 page in your dashboard.
2. Use the dropdown menus to filter by specific automations or status.