> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Automations overview

> Automate content maintenance with Mintlify automations. Run the agent on a schedule or in response to GitHub and GitLab repository pushes.

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.

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.

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

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

## Pull request grouping

Automations group related changes into a single pull request instead of opening a separate one for every change. When a later run produces more changes that belong with an open pull request, the agent appends them to that pull request rather than opening a duplicate. Grouping behavior depends on the automation. See [Predefined automations](/automations/reference) for each automation's behavior.

<Note>
  Draft changelog, Draft improvements from assistant conversations, Draft improvements from user feedback, and custom automations do not group or append. Each run opens its own pull request with the changes from that run.
</Note>

## Reviewing automation pull requests in GitHub

When an automation opens or updates a pull request, Mintlify adds context directly to the PR so you can review without leaving GitHub.

* **PR title** includes the name of the automation that generated it, so you can identify automation PRs at a glance when scanning an open PR list.
* **PR description** summarizes what changed and why. Each time a run appends new changes to an existing PR, the description updates to show a running timeline of what each run contributed.
* **PR comments** for any runs that append changes, explaining the changes and which source code pull requests the agent used as context.
* **Reviewers** assigned based on who authored the source code changes that triggered the update. Applies to automations that use source code repositories as context.

## Usage limits

Automation runs count toward your credit usage. The credits a single run consumes depend on the size of the task: how much content the agent reads, how many files it changes, and how long the run takes. Larger context repositories and broader prompts use more credits than narrowly scoped ones.

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.

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>


## Related topics

- [Use cases](/docs/agent/use-cases.md)
- [Guides](/docs/guides/index.md)
- [What is Mintlify?](/docs/what-is-mintlify.md)