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
2 changes: 1 addition & 1 deletion api/automations/trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This endpoint only supports automations configured with a **Custom schedule** tr

## Find the automation ID

Copy the automation ID from the automation's settings panel on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
Run [`mint automations list`](/cli/commands#mint-automations-list) in your terminal and copy the ID from the output.

## Example

Expand Down
12 changes: 6 additions & 6 deletions automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ For an overview of triggers, update modes, and configuration options shared acro
</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. For details on each field, see [Configurations](/automations/manage#configurations).
4. Click **Create automation**.
2. Click **New automation**.
3. On the configure page, set the automation name, trigger, prompt, context repositories, integrations, and update mode. For details on each field, see [Configurations](/automations/manage#configurations).
4. Click **Save**.

<Tip>
You can also ask the [agent in Slack](/agent/slack#manage-automations) to create an automation for you by describing what you want the automation to do.
Expand All @@ -50,7 +50,7 @@ For more examples and patterns, see [Use automations](/guides/use-automations).
## Edit a custom automation

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="settings" /> settings button beside an automation.
2. Click the <Icon icon="settings" /> settings button on the automation's card to open its configure page.
3. Update any of the fields described in [Configurations](/automations/manage#configurations).
4. Click **Save**.

Expand All @@ -59,5 +59,5 @@ For more examples and patterns, see [Use automations](/guides/use-automations).
Deleting an automation is permanent and removes its configuration and run history.

1. Open 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**.
2. Click the <Icon icon="settings" /> settings button on the automation's card to open its configure page.
3. Click **Delete automation** at the bottom of the page and confirm.
41 changes: 21 additions & 20 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,16 @@
<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**.
If the automation can run with default settings, it activates immediately. Otherwise, the automation's configure page opens so you can fill in any required configurations.
3. If the configure page opens, fill in the required fields and click **Save**.

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.
To change settings for an active automation, click the <Icon icon="settings" /> settings button on its card to open its configure page. Use the toggle in the page header to enable or disable the automation, and click **Save** to apply your changes.

## 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.
Each automation has a default trigger that controls when it runs. To change the trigger, select a different trigger type on the automation's configure page.

- **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.
Expand All @@ -50,7 +45,7 @@

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.
Select the mode in the **After automation runs** section of the automation's configure page. Select **Update and merge changes** to merge changes automatically. Select **Modify and wait for review** to require a review before changes go live.

<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.
Expand All @@ -68,7 +63,7 @@

For custom automations and supported predefined automations, enable connected [integrations](/automations/integrations). The agent pulls context from shared tools like Notion, Jira, or Linear when the automation runs.

To enable integrations for an automation, open its settings and select the integrations you want to use in **Tools**.
To enable integrations for an automation, open its configure page and select the integrations you want to use in **Tools**.

If you select **Integration** as the trigger for a custom automation, the triggering integration is always a tool for that automation. See [Integrations](/automations/integrations) for connection scopes, supported events, and permissions.

Expand Down Expand Up @@ -100,7 +95,7 @@
- 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.
You can add target languages at any time by opening the automation's configure page and editing the **Translate to** field.

<GitlabAutomationSetup />

Expand All @@ -114,19 +109,22 @@
## Delete an automation

1. Navigate to the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="settings" /> settings button beside the custom automation you want to delete.
3. Click **Delete** at the bottom of the settings panel and confirm.
2. Click the <Icon icon="settings" /> settings button on the custom automation's card to open its configure page.
3. Click **Delete automation** at the bottom of the page and confirm.

To delete any automation from the terminal, use [`mint automations`](/cli/commands#mint-automations). Deletion is permanent and cannot be undone.

## Run an automation manually

You can trigger any enabled automation on demand without waiting for its next scheduled or event-based run.
You can trigger an automation on demand without waiting for its next scheduled or event-based run.

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="play" /> run button beside the automation you want to start.
2. Click the <Icon icon="settings" /> settings button on the automation's card to open its configure page.
3. Click the run button (**Test run** or **Run now**, depending on the automation).

Manual runs use the automation's current configuration, count toward your credit usage, and appear in the run history alongside scheduled runs.
Manual runs save the automation's current configuration before starting, count toward your credit usage, and appear in the run history alongside scheduled runs.

Most automations can run manually only when they have a schedule trigger. If the run button is unavailable, hover over it to see what to change. The **Translate content** automation can always run manually.

## Trigger a scheduled automation via API

Expand All @@ -136,28 +134,31 @@

## View run history

Each automation keeps a log of past runs, including the status and a summary of changes made.
Each automation keeps a log of past runs, including the status and a summary of changes made. Runs that append changes to an open pull request from an earlier run appear as their own entries in the run history.

1. Open the [Automations](https://app.mintlify.com/products/automations?tab=runs) page in your dashboard.
2. Use the dropdown menus to filter by specific automations or status.

Each run shows one of the following statuses:

- **Review needed**: The agent finished the run, but the changes must be reviewed and merged by someone on your team.

Check warning on line 144 in automations/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/manage.mdx#L144

In general, use active voice instead of passive voice ('be reviewed').
- **Running**: The agent is actively working on the automation job.
- **Accepted**: The agent finished the run and the changes merged into your repository.
- **Closed**: The agent finished the run, but someone rejected the changes.
- **Modified**: The run appended its changes to a pull request opened by an earlier run.
- **Failed**: The agent could not complete the run. Failed runs do not count toward your daily run limit.
- **No action needed**: The agent finished the run but did not find anything to update.

Click an individual run to see its prompt, the files it read or changed, and any pull request it opened.
You can act on runs directly from the list. For runs awaiting review, click **Accept** to merge the changes. For failed runs, click **Re-trigger** to start the run again.

To see a run's prompt, the files it read or changed, and any pull request it opened, open the run's actions menu and select **View run details**.

## Continue a run in the editor

After an automation completes and creates changes on a branch, you can open those changes directly in the editor to review, refine, or publish them.

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click **View changes** beside the workflow run you want to continue working on in the editor.
2. On the **Runs** tab, click **Preview** on the run you want to continue working on in the editor.

The editor opens to the automation's branch with the agent panel already open. The agent panel shows each page the automation changed. Click any page to view changes made by the automation.

Expand Down
4 changes: 2 additions & 2 deletions automations/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Mintlify includes predefined automations for the most common documentation maint
| Fix grammar & typos | Content update | Pull request | Not supported | None |
| Enforce your style guide | Content update | Pull request | Not supported | None |

You can change all defaults from the automation's settings panel. See [Configurations](/automations/manage#configurations) for the available options.
You can change all defaults from the automation's configure page. See [Configurations](/automations/manage#configurations) for the available options.

## Self-updating content automations

Expand Down Expand Up @@ -59,7 +59,7 @@ You must enable feedback collection on the [Add-ons](https://app.mintlify.com/pr

Reviews resolved support conversations from [Intercom](/automations/integrations), [Plain](/automations/integrations), [Pylon](/automations/integrations), or [Zendesk](/automations/integrations) to identify recurring gaps in your content, then opens a pull request to address them. The agent focuses on themes across multiple conversations rather than one-off questions, so results improve as your support volume grows.

Select a single support platform when you configure the automation. Connect it from the settings panel if it isn't already connected for your organization. Add source code repositories as context to help the agent tie support themes back to the product areas they describe.
Select a single support platform when you configure the automation. Connect it from the configure page if it isn't already connected for your organization. Add source code repositories as context to help the agent tie support themes back to the product areas they describe.

Each scheduled run groups related findings into up to three themes, and opens a separate pull request for each. Every run lists the resolved support conversations it reviewed and links back to the source platform, so you can trace every content suggestion to the underlying customer feedback.

Expand Down
2 changes: 1 addition & 1 deletion es/api/automations/trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Este endpoint solo admite automatizaciones configuradas con un activador de **Pr
## Encuentra el ID de la automatización
</div>

Copia el ID de la automatización desde el panel de configuración de la automatización en la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard.
Ejecuta [`mint automations list`](/es/cli/commands#mint-automations-list) en tu terminal y copia el ID de la salida.

<div id="example">
## Ejemplo
Expand Down
12 changes: 6 additions & 6 deletions es/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ Una automatización personalizada ejecuta al agente según un calendario, en res
</Note>

1. Abre la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard.
2. Haz clic en **Create a custom automation**.
3. Configura el nombre de la automatización, el activador, las instrucciones, los repositorios de contexto, las integraciones y el modo de actualización. Para más detalles sobre cada campo, consulta [Configuraciones](/es/automations/manage#configurations).
4. Haz clic en **Create automation**.
2. Haz clic en **New automation**.
3. En la página de configuración, define el nombre de la automatización, el activador, el prompt, los repositorios de contexto, las integraciones y el modo de actualización. Para más detalles sobre cada campo, consulta [Configuraciones](/es/automations/manage#configurations).
4. Haz clic en **Save**.

<Tip>
También puedes pedirle al [agente en Slack](/es/agent/slack#manage-automations) que cree una automatización por ti describiendo lo que quieres que haga.
Expand Down Expand Up @@ -56,7 +56,7 @@ Para ver más ejemplos y patrones, consulta [Usar automatizaciones](/es/guides/u
</div>

1. Abre la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard.
2. Haz clic en el botón de configuración <Icon icon="settings" /> junto a una automatización.
2. Haz clic en el botón de configuración <Icon icon="settings" /> en la tarjeta de la automatización para abrir su página de configuración.
3. Actualiza cualquiera de los campos descritos en [Configuraciones](/es/automations/manage#configurations).
4. Haz clic en **Save**.

Expand All @@ -67,5 +67,5 @@ Para ver más ejemplos y patrones, consulta [Usar automatizaciones](/es/guides/u
Eliminar una automatización es permanente y elimina su configuración y el historial de ejecuciones.

1. Ve a la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard.
2. Haz clic en el botón de configuración <Icon icon="settings" /> junto a una automatización.
3. Haz clic en **Delete**.
2. Haz clic en el botón de configuración <Icon icon="settings" /> en la tarjeta de la automatización para abrir su página de configuración.
3. Haz clic en **Delete automation** en la parte inferior de la página y confirma.
Loading