Skip to content

docs: tighten style consistency in automations pages #6228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −4
Open

docs: tighten style consistency in automations pages #6228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 automations/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
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.

Expand All @@ -18,17 +18,17 @@

## 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.
- **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.

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.

Expand Down
2 changes: 1 addition & 1 deletion automations/manage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@

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

Expand Down
Loading