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
9 changes: 7 additions & 2 deletions api/automations/trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,14 @@
- **Release events**: Run the **Draft changelog** automation when you cut a release tag, so the changelog drafts at the same time the release ships.
- **Custom tooling**: Trigger automations from internal tools, Slack commands, or scheduled jobs you already run.

## Find the automation ID
## Find your IDs

Copy the automation ID from the automation's settings panel on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
- **Automation ID** (`workflowSchemaId`): Copy from the automation's settings panel on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
- **Project ID** (`projectId`): Copy from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard.

## Check run status

This endpoint returns as soon as the run is queued and does not wait for completion. To monitor progress, check the automation's run history on the [Automations](https://app.mintlify.com/products/automations) page in your dashboard. See [View run history](/automations/manage#view-run-history) for the statuses a run can move through.

Check warning on line 24 in api/automations/trigger.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/automations/trigger.mdx#L24

In general, use active voice instead of passive voice ('is queued').

## Example

Expand Down
3 changes: 2 additions & 1 deletion assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@

The assistant can generate page-specific questions based on the page a user is viewing, or you can add persistent questions that are available across pages.

You can add up to three starter questions. Click **Ask Assistant** for recommended questions based on your documentation.
- **Contextual starter questions**: The assistant generates suggestions from the content of the page a user is viewing. No manual input is required.

Check warning on line 60 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L60

In general, use active voice instead of passive voice ('is required').
- **Persistent starter questions**: You add up to three questions that appear on every page. Click **Ask Assistant** for recommended questions based on your documentation, then edit them to match your voice.

<Frame>
<img src="/images/assistant/search-suggestions-light.png" alt="The search suggestions panel in the dashboard with contextual starter questions enabled." className="block dark:hidden" />
Expand Down
4 changes: 4 additions & 0 deletions assistant/customize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Add a `.mintlify/Assistant.md` file at the root of your documentation project to

Instructions in an `Assistant.md` file add to the assistant's system prompt. They do not replace or override the assistant's default instructions.

Keep instructions concise and focused. Because `Assistant.md` is included in every response, long or unfocused content can crowd out user context and dilute answers. For topic-specific guidance that should only load when relevant, use [skills](/assistant/skills) instead.

Changes to `Assistant.md` take effect after your next deployment. To verify, open the assistant on your live site and ask a question that exercises your new instructions, such as a terminology preference or escalation path.

To remove the custom instructions, remove the `Assistant.md` file.

Use `Assistant.md` to:
Expand Down
6 changes: 3 additions & 3 deletions assistant/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@
...
```

The assistant uses the `name` and `description` to decide when to load a skill, so write descriptions that state when the skill applies. Keep the instructions concise. The assistant truncates skill content at approximately 6,000 tokens.
The assistant uses the `name` and `description` to decide when to load a skill, so write descriptions that state when the skill applies. Keep the instructions concise. The assistant truncates skill content at approximately 6,000 tokens. Content beyond that limit is dropped from the end of the file, so put the most important guidance first and split long procedures into separate skills.

Check warning on line 46 in assistant/skills.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/skills.mdx#L46

In general, use active voice instead of passive voice ('is dropped').

<Note>
After you add or change a `skill.md` file, redeploy your site to make the skill available to the assistant.
After you add or change a `skill.md` file, redeploy your site to make the skill available to the assistant. To verify a skill loads as expected, ask the assistant a question that matches the skill's `description`. If the wrong skill loads, tighten the `description` to be more specific about when the skill applies.
</Note>

## How the assistant uses skills
Expand All @@ -69,4 +69,4 @@

## Disable skills

Skills are on by default when at least one `skill.md` file is present. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com).
Skills are on by default when at least one `skill.md` file is present. To disable a single skill, delete its directory under `.mintlify/assistant/skills/` and redeploy your site. To remove all skills, delete the `.mintlify/assistant/skills/` directory and redeploy your site. To turn off the skills feature for your deployment, contact [support](mailto:support@mintlify.com).
10 changes: 9 additions & 1 deletion automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,14 @@ You can add target languages at any time by opening the automation's settings an

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 a custom automation

You can only delete [custom automations](/automations/create). To stop a predefined automation, disable it instead. 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 the automation.
3. Click **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 Expand Up @@ -143,7 +151,7 @@ Each run shows one of the following statuses:
- **Queued**: The run is waiting to start. Scheduled runs queue within 10 minutes of the scheduled time.
- **In progress**: The agent is actively working on the run.
- **Succeeded**: The agent finished the run. If the automation made changes, the run links to the resulting commit or pull request.
- **Failed**: The agent could not complete the run. Failed runs do not count toward your daily run limit.
- **Failed**: The agent could not complete the run. Failed runs do not count toward your daily run limit. To retry, [run the automation manually](#run-an-automation-manually) or wait for its next scheduled trigger.
- **No changes**: 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.
Expand Down
10 changes: 10 additions & 0 deletions cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ keywords: ["CLI", "mint", "commands", "flags", "reference"]
boost: 3
---

## Prerequisites

The `mint` CLI requires [Node.js](https://nodejs.org) v20.17.0 or higher. Install the CLI globally with npm:

```bash
npm i -g mint
```

Run commands from the root of your documentation project (the directory containing `docs.json`) unless a command explicitly accepts a path argument. See the [Quickstart](/quickstart) for a full walkthrough.

## Global flags

These flags are available on all commands.
Expand Down
13 changes: 10 additions & 3 deletions es/api/automations/trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,18 @@ Este endpoint solo admite automatizaciones configuradas con un activador de **Pr
- **Eventos de versión**: Ejecuta la automatización **Draft changelog** cuando creas una etiqueta de versión, para que el changelog se redacte al mismo tiempo que se publica la versión.
- **Herramientas personalizadas**: Activa automatizaciones desde herramientas internas, comandos de Slack o tareas programadas que ya ejecutas.

<div id="find-the-automation-id">
## Encuentra el ID de la automatización
<div id="find-your-ids">
## Encuentra tus IDs
</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.
- **ID de la automatización** (`workflowSchemaId`): Cópialo desde el panel de configuración de la automatización en la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard.
- **ID del proyecto** (`projectId`): Cópialo desde la página de [API keys](https://app.mintlify.com/settings/organization/api-keys) de tu dashboard.

<div id="check-run-status">
## Consultar el estado de la ejecución
</div>

Este endpoint responde en cuanto la ejecución se pone en cola y no espera a que se complete. Para hacer seguimiento del progreso, revisa el historial de ejecuciones de la automatización en la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard. Consulta [Ver el historial de ejecuciones](/es/automations/manage#view-run-history) para conocer los estados por los que puede pasar una ejecución.

<div id="example">
## Ejemplo
Expand Down
3 changes: 2 additions & 1 deletion es/assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ Ayuda a tus usuarios a iniciar conversaciones con el assistant agregando pregunt

El assistant puede generar preguntas específicas de la página basándose en la página que el usuario está viendo, o puedes agregar preguntas persistentes que estén disponibles en todas las páginas.

Puedes agregar hasta tres preguntas iniciales. Haz clic en **Preguntar al asistente** para obtener preguntas recomendadas basadas en tu documentación.
- **Preguntas iniciales contextuales**: El assistant genera sugerencias a partir del contenido de la página que el usuario está viendo. No se requiere entrada manual.
- **Preguntas iniciales persistentes**: Agregas hasta tres preguntas que aparecen en cada página. Haz clic en **Preguntar al asistente** para obtener preguntas recomendadas basadas en tu documentación, luego edítalas para que coincidan con tu voz.

<Frame>
<img src="/images/assistant/search-suggestions-light.png" alt="El panel de sugerencias de búsqueda en el dashboard con preguntas iniciales contextuales habilitadas." className="block dark:hidden" />
Expand Down
4 changes: 3 additions & 1 deletion es/assistant/customize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@ Agrega un archivo `.mintlify/Assistant.md` en la raíz de tu proyecto de documen

Las instrucciones en un archivo `Assistant.md` se añaden al prompt de sistema del assistant. No reemplazan ni anulan las instrucciones predeterminadas del assistant.

Para orientación profunda y específica de un tema que el assistant debería incorporar solo cuando una pregunta coincida, usa [assistant skills](/es/assistant/skills) en lugar de agregar contenido a `Assistant.md`.
Mantén las instrucciones concisas y enfocadas. Como `Assistant.md` se incluye en cada respuesta, un contenido largo o poco enfocado puede desplazar el contexto del usuario y diluir las respuestas. Para orientación específica de un tema que solo debería cargarse cuando sea relevante, usa [skills](/es/assistant/skills) en su lugar.

Los cambios en `Assistant.md` surten efecto después de tu próximo despliegue. Para verificarlo, abre el assistant en tu sitio en vivo y haz una pregunta que ponga a prueba tus nuevas instrucciones, como una preferencia de terminología o una ruta de escalación.

Para eliminar las instrucciones personalizadas, elimina el archivo `Assistant.md`.

Expand Down
6 changes: 3 additions & 3 deletions es/assistant/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ Follow these steps to upgrade an existing v2 integration to v3.
...
```

El assistant usa `name` y `description` para decidir si carga la skill, así que escribe descripciones que indiquen claramente cuándo aplica la guía. Mantén el cuerpo enfocado: el contenido de la skill se trunca aproximadamente a 6,000 tokens cuando se carga.
El assistant usa `name` y `description` para decidir si carga la skill, así que escribe descripciones que indiquen claramente cuándo aplica la guía. Mantén el cuerpo enfocado: el contenido de la skill se trunca aproximadamente a 6,000 tokens cuando se carga. El contenido que excede ese límite se descarta desde el final del archivo, así que coloca primero la orientación más importante y divide los procedimientos largos en skills separadas.

<Note>
Las skills se descubren en tu próxima actualización de documentación. Después de agregar o cambiar un archivo `skill.md`, publica tus docs para que la skill esté disponible para el assistant.
Después de agregar o cambiar un archivo `skill.md`, vuelve a desplegar tu sitio para que la skill esté disponible para el assistant. Para verificar que una skill se cargue como esperas, hazle al assistant una pregunta que coincida con la `description` de la skill. Si se carga la skill equivocada, ajusta la `description` para que sea más específica sobre cuándo aplica la skill.
</Note>

<div id="how-the-assistant-uses-skills">
Expand Down Expand Up @@ -77,4 +77,4 @@ Las skills funcionan junto con las [instrucciones personalizadas del assistant](
## Deshabilitar skills
</div>

Las skills están activadas de forma predeterminada cuando hay al menos un archivo `skill.md` presente. Para desactivar las skills por completo en tu deployment, contacta a [soporte](mailto:support@mintlify.com) para deshabilitar la función de assistant skills. Eliminar el directorio `.mintlify/assistant/skills/` y volver a publicar también limpia el catálogo.
Las skills están activadas de forma predeterminada cuando hay al menos un archivo `skill.md` presente. Para deshabilitar una única skill, elimina su directorio dentro de `.mintlify/assistant/skills/` y vuelve a desplegar tu sitio. Para eliminar todas las skills, elimina el directorio `.mintlify/assistant/skills/` y vuelve a desplegar tu sitio. Para desactivar la función de skills en tu deployment, contacta a [soporte](mailto:support@mintlify.com).
12 changes: 11 additions & 1 deletion es/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,16 @@ 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-a-custom-automation">
## Eliminar una automatización personalizada
</div>

Solo puedes eliminar [automatizaciones personalizadas](/es/automations/create). Para detener una automatización predefinida, desactívala en su lugar. Eliminar una automatización es permanente y elimina su configuración y su historial de ejecuciones.

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 la automatización.
3. Haz clic en **Delete**.

<div id="run-an-automation-manually">
## Ejecutar una automatización manualmente
</div>
Expand Down Expand Up @@ -171,7 +181,7 @@ Cada ejecución muestra uno de los siguientes estados:
- **Queued**: La ejecución está esperando para comenzar. Las ejecuciones programadas se ponen en cola dentro de los 10 minutos siguientes a la hora programada.
- **In progress**: El agente está trabajando activamente en la ejecución.
- **Succeeded**: El agente finalizó la ejecución. Si la automatización realizó cambios, la ejecución enlaza con el commit o la pull request resultante.
- **Failed**: El agente no pudo completar la ejecución. Las ejecuciones fallidas no cuentan para tu límite diario de ejecuciones.
- **Failed**: El agente no pudo completar la ejecución. Las ejecuciones fallidas no cuentan para tu límite diario de ejecuciones. Para reintentar, [ejecuta la automatización manualmente](#run-an-automation-manually) o espera a su próximo activador programado.
- **No changes**: El agente finalizó la ejecución pero no encontró nada que actualizar.

Haz clic en una ejecución individual para ver su prompt, los archivos que leyó o modificó y cualquier pull request que haya abierto.
Expand Down
12 changes: 12 additions & 0 deletions es/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ keywords: ["CLI", "mint", "comandos", "flags", "referencia"]
boost: 3
---

<div id="prerequisites">
## Requisitos previos
</div>

La CLI `mint` requiere [Node.js](https://nodejs.org) v20.17.0 o superior. Instala la CLI de forma global con npm:

```bash
npm i -g mint
```

Ejecuta los comandos desde la raíz de tu proyecto de documentación (el directorio que contiene `docs.json`) a menos que un comando acepte explícitamente un argumento de ruta. Consulta la [Quickstart](/es/quickstart) para ver un recorrido completo.

<div id="global-flags">
## Flags globales
</div>
Expand Down
6 changes: 6 additions & 0 deletions es/organize/settings-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ keywords: ["docs.json", "schema", "reference", "configuration", "all settings",

Los campos obligatorios tienen una insignia <Badge color="red">required</Badge>. Todos los demás campos son opcionales.

Tu archivo `docs.json` reside en la raíz de tu repositorio de documentación. Consulta [Configuración global](/es/organize/settings) para conocer los fundamentos de la configuración.

<Tip>
Agrega `"$schema": "https://mintlify.com/docs.json"` al principio de tu `docs.json` para obtener autocompletado y validación en editores como VS Code. Para validar `docs.json` localmente, ejecuta [`mint dev`](/es/cli/commands#mint-dev) o [`mint validate`](/es/cli/commands#mint-validate) desde la raíz de tu proyecto: los errores de esquema aparecen al iniciar.
</Tip>

Para obtener contexto sobre lo que hace cada grupo de ajustes, consulta las páginas de temas:

* [Apariencia y marca](/es/organize/settings-appearance)
Expand Down
13 changes: 10 additions & 3 deletions fr/api/automations/trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,18 @@ Cet endpoint ne prend en charge que les automatisations configurées avec un dé
- **Événements de version** : Exécutez l'automatisation **Draft changelog** lorsque vous créez un tag de version, afin que le changelog soit rédigé au moment même où la version est publiée.
- **Outillage personnalisé** : Déclenchez des automatisations depuis vos outils internes, des commandes Slack ou des tâches planifiées que vous exécutez déjà.

<div id="find-the-automation-id">
## Trouver l'identifiant de l'automatisation
<div id="find-your-ids">
## Trouver vos identifiants
</div>

Copiez l'identifiant de l'automatisation depuis le panneau de paramètres de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard.
- **Identifiant d'automatisation** (`workflowSchemaId`) : Copiez-le depuis le panneau de paramètres de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard.
- **Identifiant de projet** (`projectId`) : Copiez-le depuis la page [API keys](https://app.mintlify.com/settings/organization/api-keys) de votre dashboard.

<div id="check-run-status">
## Vérifier le statut de l'exécution
</div>

Cet endpoint renvoie une réponse dès que l'exécution est mise en file d'attente et n'attend pas la fin de celle-ci. Pour suivre son avancement, consultez l'historique des exécutions de l'automatisation sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. Consultez [Consulter l'historique des exécutions](/fr/automations/manage#view-run-history) pour connaître les statuts par lesquels une exécution peut passer.

<div id="example">
## Exemple
Expand Down
3 changes: 2 additions & 1 deletion fr/assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ Aidez vos utilisateurs à démarrer des conversations avec l'assistant en ajouta

L'assistant peut générer des questions spécifiques à la page en fonction de la page consultée par l'utilisateur, ou vous pouvez ajouter des questions persistantes disponibles sur toutes les pages.

Vous pouvez ajouter jusqu'à trois questions de démarrage. Cliquez sur **Demander à l'assistant** pour obtenir des questions recommandées basées sur votre documentation.
- **Questions de démarrage contextuelles** : L'assistant génère des suggestions à partir du contenu de la page consultée par l'utilisateur. Aucune saisie manuelle n'est requise.
- **Questions de démarrage persistantes** : Vous ajoutez jusqu'à trois questions qui apparaissent sur toutes les pages. Cliquez sur **Ask Assistant** pour obtenir des questions recommandées basées sur votre documentation, puis modifiez-les pour qu'elles correspondent à votre ton.

<Frame>
<img src="/images/assistant/search-suggestions-light.png" alt="Le panneau de suggestions de recherche dans le tableau de bord avec les questions de démarrage contextuelles activées." className="block dark:hidden" />
Expand Down
Loading
Loading