Skip to content
Open
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
10 changes: 10 additions & 0 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@
continue where you left off with the new deployment.
</Tip>

### Disconnect the agent

To remove the agent from your Slack workspace:

1. Open your Mintlify dashboard and go to the Slack agent settings.
2. Click **Disconnect** to remove the workspace connection.
3. In Slack, open **Settings & administration** → **Manage apps**, find `mintlify`, and remove it from the workspace.

Removing the app stops the agent from responding in any channel or thread. In-progress agent runs finish and post their results, but no new requests are accepted until you reinstall.

Check warning on line 63 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L63

In general, use active voice instead of passive voice ('are accepted').

## Use the agent in Slack

Once connected, you can:
Expand Down
20 changes: 18 additions & 2 deletions automations/create.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Create a custom automation"
description: "Create a custom Mintlify automation that runs on a schedule, a push to a repository, or when an integration event occurs. Add context repositories and an agent prompt to the automation to customize its behavior."
description: "Create a custom Mintlify automation that runs on a schedule, repository push, or integration event, with context repositories and an agent prompt."
keywords: ["automation", "automate", "cron", "agent", "custom automation"]
---

Expand All @@ -18,9 +18,25 @@ import GitlabAutomationSetup from '/snippets/gitlab-automation-setup.mdx';
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>

Inside the sandbox, the agent can:

- Read files in your documentation repository and any connected context repositories.
- Use the shared and personal [integrations](/automations/integrations) you select as tools.
- Edit MDX files and open a pull request against your documentation repository.

The sandbox cannot make arbitrary outbound network requests, install packages, or run shell commands beyond the tools Mintlify provides.

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).
3. Configure the automation:
- **Name**: A short, descriptive label shown in the dashboard and run history.
- **Trigger**: When the automation runs (content update, code change, custom schedule, or integration event).
- **Instructions**: The prompt the agent follows on each run.
- **Context repositories**: Extra repositories the agent can read for additional context.
- **Integrations**: Shared integrations the agent can call as tools during the run.
- **Update mode**: How the agent proposes changes—open a pull request, commit directly, or another mode.

For full details on each field, see [Configurations](/automations/manage#configurations).
4. Click **Create automation**.

## Write effective instructions
Expand Down
10 changes: 10 additions & 0 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,16 @@

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.

## Delete an automation

Deleting an automation is permanent and removes its configuration and run history. Predefined automations cannot be deleted; disable them instead.

Check warning on line 120 in automations/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/manage.mdx#L120

In general, use active voice instead of passive voice ('be deleted').

Check warning on line 120 in automations/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

automations/manage.mdx#L120

Use semicolons judiciously.

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="settings" /> settings button beside a custom automation.
3. Click **Delete**.

You can also delete an automation from the terminal with [`mint automations delete`](/cli/commands#mint-automations-delete).

## Run an automation manually

You can trigger any enabled automation on demand without waiting for its next scheduled or event-based run.
Expand Down
6 changes: 6 additions & 0 deletions cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
boost: 3
---

To install or upgrade the CLI, see [Install the CLI](/cli/install).

## Global flags

These flags are available on all commands.
Expand Down Expand Up @@ -247,7 +249,9 @@
| `--check-redirects` | Also check that redirect destinations in `docs.json` resolve to valid paths. |
| `--check-snippets` | Also check links inside `<Snippet>` components. |

The command exits with a non-zero status when it finds broken links, so you can gate CI on the result.

Pass `--files` to limit the check to specific pages. This is useful for validating a single page you just edited or scoping checks to a directory in CI. When `--files` is set with `--check-external`, only external URLs on the selected pages are fetched.

Check warning on line 254 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L254

In general, use active voice instead of passive voice ('are fetched').

```bash
# Check a specific page
Expand Down Expand Up @@ -277,6 +281,8 @@
| `--skip-contrast` | Skip color contrast checks. |
| `--skip-alt-text` | Skip missing alt text checks. |

The command exits with a non-zero status when it finds accessibility issues, so you can gate CI on the result.

---

## `mint validate`
Expand Down Expand Up @@ -427,13 +433,13 @@
mint format
```

Run the command from the root of your docs project. It walks every subdirectory, skipping paths matched by `.gitignore` and any Mintlify ignore rules. Files that already match the canonical output are left untouched.

Check warning on line 436 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L436

In general, use active voice instead of passive voice ('are left').

<Warning>
`mint format` rewrites files in place. Commit or stash your changes before running it so you can review the diff.
</Warning>

When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting.

Check warning on line 442 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L442

In general, use active voice instead of passive voice ('were reformatted').

---

Expand Down
2 changes: 2 additions & 0 deletions cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation

The CLI runs on your machine and connects to your Mintlify deployment when you need live data.

The CLI installs from npm and requires Node.js v20.17.0 or newer. See [Install the CLI](/cli/install) for setup instructions.

### Preview locally
Run `mint dev` to preview your documentation at `localhost:3000`. As you write and update your content, changes appear in real time without deploying. Log in to enable search and the AI assistant in your local preview.

Expand Down
12 changes: 12 additions & 0 deletions es/agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,18 @@ el mensaje de estado del agente en el hilo. El agente conserva tu historial de
conversación para que puedas continuar donde lo dejaste con el nuevo despliegue.
</Tip>

<div id="disconnect-the-agent">
### Desconectar el agente
</div>

Para eliminar el agente de tu espacio de trabajo de Slack:

1. Abre tu dashboard de Mintlify y ve a la configuración del agente de Slack.
2. Haz clic en **Disconnect** para eliminar la conexión con el espacio de trabajo.
3. En Slack, abre **Settings & administration** → **Manage apps**, busca `mintlify` y elimínalo del espacio de trabajo.

Al eliminar la app, el agente deja de responder en cualquier canal o hilo. Las ejecuciones del agente en curso finalizan y publican sus resultados, pero no se aceptan nuevas solicitudes hasta que lo reinstales.

<div id="use-the-agent-in-slack">
## Usar el agente en Slack
</div>
Expand Down
18 changes: 17 additions & 1 deletion es/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,25 @@ import GitlabAutomationSetup from '/snippets/es/gitlab-automation-setup.mdx';
El agente se ejecuta en un sandbox aislado con acceso restringido a internet. No puede instalar paquetes o herramientas adicionales en tiempo de ejecución. Los prompts que hagan referencia a herramientas no disponibles pueden producir resultados inesperados o fallar.
</Note>

Dentro del sandbox, el agente puede:

- Leer archivos en tu repositorio de documentación y en cualquier repositorio de contexto conectado.
- Usar las [integraciones](/es/automations/integrations) compartidas y personales que selecciones como herramientas.
- Editar archivos MDX y abrir una pull request en tu repositorio de documentación.

El sandbox no puede realizar solicitudes de red salientes arbitrarias, instalar paquetes ni ejecutar comandos de shell más allá de las herramientas que proporciona Mintlify.

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).
3. Configura la automatización:
- **Nombre**: Una etiqueta corta y descriptiva que se muestra en el dashboard y en el historial de ejecuciones.
- **Activador**: Cuándo se ejecuta la automatización (actualización de contenido, cambio de código, programación personalizada o evento de integración).
- **Instrucciones**: El prompt que sigue el agente en cada ejecución.
- **Repositorios de contexto**: Repositorios adicionales que el agente puede leer para obtener más contexto.
- **Integraciones**: Integraciones compartidas que el agente puede invocar como herramientas durante la ejecución.
- **Modo de actualización**: Cómo propone cambios el agente: abrir una pull request, hacer commit directamente u otro modo.

Para más detalles sobre cada campo, consulta [Configuraciones](/es/automations/manage#configurations).
4. Haz clic en **Create automation**.

<div id="write-effective-instructions">
Expand Down
12 changes: 12 additions & 0 deletions es/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,18 @@ Puedes añadir idiomas de destino en cualquier momento abriendo la configuració

Cuando vuelves a activar una automatización programada o cambias su programación, Mintlify recalcula el próximo tiempo de ejecución a partir de la hora actual. Las automatizaciones desactivadas no conservan un tiempo de ejecución pendiente.

<div id="delete-an-automation">
## Eliminar una automatización
</div>

Eliminar una automatización es permanente y elimina su configuración y el historial de ejecuciones. Las automatizaciones predefinidas no se pueden eliminar; en su lugar, desactívalas.

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 personalizada.
3. Haz clic en **Delete**.

También puedes eliminar una automatización desde la terminal con [`mint automations delete`](/es/cli/commands#mint-automations-delete).

<div id="run-an-automation-manually">
## Ejecutar una automatización manualmente
</div>
Expand Down
6 changes: 6 additions & 0 deletions es/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ keywords: ["CLI", "mint", "comandos", "flags", "referencia"]
boost: 3
---

Para instalar o actualizar la CLI, consulta [Instalar la CLI](/es/cli/install).

<div id="global-flags">
## Flags globales
</div>
Expand Down Expand Up @@ -277,6 +279,8 @@ El comando excluye los archivos que coinciden con los patrones de [.mintignore](
| `--check-redirects` | También verificar que los destinos de redirección en `docs.json` se resuelvan a rutas válidas. |
| `--check-snippets` | También verificar enlaces dentro de componentes `<Snippet>`. |

El comando finaliza con un estado distinto de cero cuando encuentra enlaces rotos, para que puedas condicionar CI al resultado.

Usa `--files` para limitar la verificación a páginas específicas. Es útil para validar una sola página que acabas de editar o para acotar las verificaciones a un directorio en CI. Cuando se combina `--files` con `--check-external`, solo se comprueban las URLs externas de las páginas seleccionadas.

```bash
Expand Down Expand Up @@ -309,6 +313,8 @@ Verifica las relaciones de contraste de color y la falta de texto alternativo en
| `--skip-contrast` | Omitir las verificaciones de contraste de color. |
| `--skip-alt-text` | Omitir las verificaciones de texto alternativo faltante. |

El comando finaliza con un estado distinto de cero cuando encuentra problemas de accesibilidad, para que puedas condicionar CI al resultado.

---

<div id="mint-validate">
Expand Down
2 changes: 2 additions & 0 deletions es/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Usa la [CLI](https://www.npmjs.com/package/mint) para previsualizar tu documenta

La CLI se ejecuta en tu máquina y se conecta a tu despliegue de Mintlify cuando necesitas datos en vivo.

La CLI se instala desde npm y requiere Node.js v20.17.0 o superior. Consulta [Instalar la CLI](/es/cli/install) para las instrucciones de configuración.

<div id="preview-locally">
### Previsualización local
</div>
Expand Down
12 changes: 12 additions & 0 deletions fr/agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,18 @@ conversation afin que vous puissiez reprendre là où vous en étiez avec le nou
déploiement.
</Tip>

<div id="disconnect-the-agent">
### Déconnecter l'agent
</div>

Pour retirer l'agent de votre espace de travail Slack :

1. Ouvrez votre dashboard Mintlify et accédez aux paramètres de l'agent Slack.
2. Cliquez sur **Disconnect** pour supprimer la connexion à l'espace de travail.
3. Dans Slack, ouvrez **Settings & administration** → **Manage apps**, trouvez `mintlify` et supprimez-le de l'espace de travail.

La suppression de l'application empêche l'agent de répondre dans tout canal ou fil. Les exécutions d'agent en cours se terminent et publient leurs résultats, mais aucune nouvelle demande n'est acceptée jusqu'à ce que vous réinstalliez l'application.

<div id="use-the-agent-in-slack">
## Utiliser l'agent dans Slack
</div>
Expand Down
18 changes: 17 additions & 1 deletion fr/automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,25 @@ import GitlabAutomationSetup from '/snippets/fr/gitlab-automation-setup.mdx';
L'agent s'exécute dans un sandbox isolé avec un accès Internet restreint. Il ne peut pas installer de packages ou d'outils supplémentaires à l'exécution. Les prompts qui font référence à des outils indisponibles peuvent produire des résultats inattendus ou échouer.
</Note>

Dans le sandbox, l'agent peut :

- Lire les fichiers de votre dépôt de documentation et de tout dépôt de contexte connecté.
- Utiliser les [intégrations](/fr/automations/integrations) partagées et personnelles que vous sélectionnez comme outils.
- Modifier des fichiers MDX et ouvrir une pull request sur votre dépôt de documentation.

Le sandbox ne peut pas effectuer de requêtes réseau sortantes arbitraires, installer des packages, ni exécuter des commandes shell au-delà des outils fournis par Mintlify.

1. Ouvrez la page [Automations](https://app.mintlify.com/products/automations) dans votre dashboard.
2. Cliquez sur **Create a custom automation**.
3. Configurez le nom de l'automatisation, le déclencheur, les instructions, les dépôts de contexte, les intégrations et le mode de mise à jour. Pour plus de détails sur chaque champ, consultez [Configurations](/fr/automations/manage#configurations).
3. Configurez l'automatisation :
- **Nom** : Une étiquette courte et descriptive affichée dans le dashboard et l'historique des exécutions.
- **Déclencheur** : Le moment où l'automatisation s'exécute (mise à jour de contenu, modification de code, calendrier personnalisé ou événement d'intégration).
- **Instructions** : Le prompt que l'agent suit à chaque exécution.
- **Dépôts de contexte** : Dépôts supplémentaires que l'agent peut lire pour obtenir plus de contexte.
- **Intégrations** : Intégrations partagées que l'agent peut appeler comme outils pendant l'exécution.
- **Mode de mise à jour** : Comment l'agent propose les modifications — ouvrir une pull request, committer directement, ou un autre mode.

Pour plus de détails sur chaque champ, consultez [Configurations](/fr/automations/manage#configurations).
4. Cliquez sur **Create automation**.

<div id="write-effective-instructions">
Expand Down
14 changes: 13 additions & 1 deletion fr/automations/manage.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Gérer les automatisations"
description: "Activez, désactivez, déclenchez et supprimez des automatisations. Configurez les déclencheurs de dépôt, de calendrier et d'intégration, le contexte et l'automerge."
description: "Activez, désactivez, exécutez et supprimez des automatisations. Configurez les déclencheurs de dépôt, de calendrier et d'intégration, et l'automerge."
keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"]
---

Expand Down Expand Up @@ -137,6 +137,18 @@ Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres

Lorsque vous réactivez une automatisation planifiée ou modifiez son calendrier, Mintlify recalcule la prochaine heure d'exécution à partir de l'heure actuelle. Les automatisations désactivées ne conservent pas d'heure d'exécution en attente.

<div id="delete-an-automation">
## Supprimer une automatisation
</div>

La suppression d'une automatisation est définitive et supprime sa configuration ainsi que l'historique de ses exécutions. Les automatisations prédéfinies ne peuvent pas être supprimées ; désactivez-les à la place.

1. Ouvrez la page [Automations](https://app.mintlify.com/products/automations) dans votre dashboard.
2. Cliquez sur le bouton <Icon icon="settings" /> de paramètres à côté d'une automatisation personnalisée.
3. Cliquez sur **Delete**.

Vous pouvez également supprimer une automatisation depuis le terminal avec [`mint automations delete`](/fr/cli/commands#mint-automations-delete).

<div id="run-an-automation-manually">
## Exécuter une automatisation manuellement
</div>
Expand Down
6 changes: 6 additions & 0 deletions fr/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ keywords: ["CLI", "mint", "commandes", "flags", "référence"]
boost: 3
---

Pour installer ou mettre à jour la CLI, consultez [Installer la CLI](/fr/cli/install).

<div id="global-flags">
## Flags globaux
</div>
Expand Down Expand Up @@ -277,6 +279,8 @@ La commande exclut les fichiers correspondant aux motifs [.mintignore](/fr/organ
| `--check-redirects` | Vérifier également que les destinations de redirection dans `docs.json` se résolvent vers des chemins valides. |
| `--check-snippets` | Vérifier également les liens à l'intérieur des composants `<Snippet>`. |

La commande se termine avec un statut non nul lorsqu'elle trouve des liens cassés, ce qui vous permet de conditionner la CI sur ce résultat.

Utilisez `--files` pour limiter la vérification à des pages spécifiques. C'est utile pour valider une seule page que vous venez de modifier ou pour restreindre les vérifications à un répertoire en CI. Lorsque `--files` est combiné avec `--check-external`, seules les URLs externes des pages sélectionnées sont vérifiées.

```bash
Expand Down Expand Up @@ -309,6 +313,8 @@ Vérifie les rapports de contraste de couleur et les textes alternatifs manquant
| `--skip-contrast` | Ignorer les vérifications de contraste de couleur. |
| `--skip-alt-text` | Ignorer les vérifications de texte alternatif manquant. |

La commande se termine avec un statut non nul lorsqu'elle trouve des problèmes d'accessibilité, ce qui vous permet de conditionner la CI sur ce résultat.

---

<div id="mint-validate">
Expand Down
2 changes: 2 additions & 0 deletions fr/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Utilisez la [CLI](https://www.npmjs.com/package/mint) pour prévisualiser votre

La CLI s'exécute sur votre machine et se connecte à votre déploiement Mintlify lorsque vous avez besoin de données en direct.

La CLI s'installe depuis npm et nécessite Node.js v20.17.0 ou plus récent. Consultez [Installer la CLI](/fr/cli/install) pour les instructions d'installation.

<div id="preview-locally">
### Prévisualisation locale
</div>
Expand Down
12 changes: 12 additions & 0 deletions zh/agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,18 @@ keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", "
**Switch deployment** 按钮。Agent 会保留你的对话历史记录,以便你在新部署上从之前中断的地方继续。
</Tip>

<div id="disconnect-the-agent">
### 断开 agent 连接
</div>

如需从你的 Slack 工作区移除 agent:

1. 打开你的 Mintlify dashboard,进入 Slack agent 设置。
2. 点击 **Disconnect** 以移除该工作区连接。
3. 在 Slack 中,打开 **Settings & administration** → **Manage apps**,找到 `mintlify`,并将其从工作区中移除。

移除该应用后,agent 将不再在任何频道或线程中作出响应。正在进行中的 agent 运行会继续完成并发布结果,但在你重新安装之前不会接受新的请求。

<div id="use-the-agent-in-slack">
## 在 Slack 中使用智能体
</div>
Expand Down
Loading