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
14 changes: 14 additions & 0 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,20 @@ The agent is an AI tool that creates pull requests with proposed changes to your

All changes go through pull requests. The agent never commits directly to your main branch.

## Get started

1. Open the [Agent](https://app.mintlify.com/products/agent) page in your dashboard.
2. Install the Mintlify GitHub App on the repositories you want the agent to work with.
3. Send your first request from the agent panel, from Slack, or by opening a pull request in a connected repository.
4. Review the pull request the agent opens and merge it when you're ready.

## How the agent stays safe

- Opens pull requests only. The agent never commits directly to your deployment branch.
- Only accesses repositories that you connect through the Mintlify GitHub App.
- Treats non-documentation repositories as read-only, using them for context but never writing to them.
- Requires human review and merge before any change reaches your live site.

## What you can do with the agent

Use the agent to:
Expand Down
13 changes: 11 additions & 2 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@

When you reinstall the agent into a workspace that is already connected to your organization, Mintlify refreshes the stored bot token in place. Your existing channels and threads remain intact.

### Disconnect the agent

To remove the agent from your Slack workspace:

1. In Slack, go to **Settings & administration > Manage apps** and open the `mintlify` app.
2. Click **Remove app** to uninstall it from the workspace.

After removal, the agent stops responding to mentions and direct messages. Existing thread history remains in Slack, but the agent cannot access it. Reinstall the app from your Mintlify dashboard to reconnect.

<Tip>
If your organization has multiple deployments, the agent asks you to select which deployment to work with the first time you send a request.

Expand All @@ -60,8 +69,8 @@

Once connected, you can:

- Send direct messages to the agent to use it privately.
- Mention `@mintlify` in a channel to use it publicly and collaboratively.
- Send direct messages to the agent to use it privately. Direct messages work as soon as the app is installed.

Check warning on line 72 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L72

In general, use active voice instead of passive voice ('is installed').
- Mention `@mintlify` in a channel to use it publicly and collaboratively. The agent only responds in channels it has been invited to—run `/invite @mintlify` in a channel to add it.

Check warning on line 73 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L73

In general, use active voice instead of passive voice ('been invited').
- Attach files and images directly to your messages for the agent to process and include in your docs.
- Continue conversations in threads to iterate on changes or ask follow-up questions. The agent reuses files, images, and emoji reactions from earlier in the thread as context for follow-up requests, so you don't have to reupload them.
- Share pull request links with the agent to update related documentation.
Expand Down
13 changes: 13 additions & 0 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,19 @@ Each run shows one of the following statuses:

Click an individual run to see its prompt, the files it read or changed, and any pull request it opened.

### Troubleshoot a failed run

If a run shows the **Failed** status, open it from the [Automation Runs](https://app.mintlify.com/products/automations) page to see the agent's prompt, tool calls, and error output.

Common causes:

- Missing access to a context or source code repository. Reinstall the [Mintlify GitHub App](/deploy/github) on the affected repository.
- A revoked integration token. Reconnect the integration on the [Integrations](https://app.mintlify.com/settings/organization/integrations) page.
- An invalid `docs.json` or validation error in the project repository.
- A schedule or trigger that fires before the previous run has finished.

After you address the underlying issue, click the <Icon icon="play" /> run button beside the automation to retry it. Failed runs do not count toward your daily run limit, so retries are safe.

## 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.
Expand Down
2 changes: 2 additions & 0 deletions automations/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ keywords: ["predefined", "automation", "default"]

Mintlify includes predefined automations for the most common documentation maintenance tasks. Each automation has a base prompt and a default configuration. You can customize the trigger, update mode, and instructions from the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.

If none of the predefined automations fit your use case, see [Create a custom automation](/automations/create) to define your own prompt, trigger, and context repositories.

## At a glance

| Automation | Default trigger | Default update mode | Context repos | Required configuration |
Expand Down
2 changes: 2 additions & 0 deletions create/changelogs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ See the [Mintlify changelog](/changelog) as an example: you can include links, i
Add an `Update` for each changelog entry.

Include relevant information like feature releases, bug fixes, or other announcements.

Entries appear in the order you list them in the file. Add new entries at the top of the file to display the most recent updates first.
</Step>
</Steps>

Expand Down
8 changes: 8 additions & 0 deletions deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,14 @@ When an unauthenticated user tries to access a protected page, the redirect to y
</Tab>
</Tabs>

### Test your configuration

Before you share the URL with users, verify that authentication works as expected:

- **Preview deployments**: [Preview deployments](/deploy/preview-deployments) respect the same authentication settings as your production site. Push a branch and open the preview URL to confirm the login flow works end to end.
- **Test with a real account**: Sign in with a test user or a member of each group that should have access, and confirm that restricted pages appear or hide as expected.
- **Local development**: `mint dev` serves your site without enforcing authentication so you can iterate on content. Always confirm access rules against a preview or production deployment, not the local server.

## Make pages public

When using authentication, all pages require authentication to access by default. You can make specific pages viewable without authentication at the page or group level with the `public` property.
Expand Down
9 changes: 9 additions & 0 deletions deploy/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
The exported archive is a static, unauthenticated bundle. Anyone with the zip file can view every page it contains.

- The `--groups` flag controls which group-restricted pages Mintlify includes in the archive at export time. It does not enforce authentication after export.
- Only share archives with recipients who are allowed to see the content they contain.

Check warning on line 53 in deploy/export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/export.mdx#L53

In general, use active voice instead of passive voice ('are allowed').
- Regenerate and redistribute the archive to publish new changes. Anyone running an older zip continues to see the older content.

## What's in the zip
Expand All @@ -65,6 +65,15 @@
| `Start Docs.command` | macOS launcher—double-click to open the docs |
| `Start Docs.bat` | Windows launcher—double-click to open the docs |

### Feature support

The exported archive is a static bundle, so features that depend on Mintlify's cloud services are not available offline:

- **Supported offline**: Page navigation, images, code samples, Mermaid diagrams, and other pre-rendered content.
- **Not supported offline**: Full-text search, the AI assistant, the interactive API playground, analytics, feedback widgets, and authentication.

Recipients who need these features must access your live site.

## View the exported docs

Share the zip file with anyone who has Node.js installed. To view the docs:
Expand Down
16 changes: 15 additions & 1 deletion editor/branching-and-publishing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,21 @@

Conflicts occur when your branch and the deployment branch have incompatible changes to the same files. For example, when you and a teammate edited the same lines in a file or moved a file to different locations.

The editor displays a warning when conflicts block publishing. Follow the prompts to choose which version of each conflicting section to keep.
The editor displays a warning when conflicts block publishing. To resolve them:

1. Open the conflict warning in the publish menu to see the list of conflicting files.
2. Click a file to open it. The editor shows your changes alongside the incoming changes from the deployment branch.
3. For each conflict, choose **Keep mine**, **Keep theirs**, or edit the section manually to combine both.

Check warning on line 166 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L166

Avoid first-person pronouns such as 'mine'.
4. Save the file to clear the conflict, then publish again.

## Revert a published change

To undo a change after it has been published, revert the commit in your Git provider:

Check warning on line 171 in editor/branching-and-publishing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/branching-and-publishing.mdx#L171

In general, use active voice instead of passive voice ('been published').

- **GitHub**: Open the merged pull request or the commit in the repository and click **Revert**. Merge the revert pull request to publish the rollback.
- **GitLab**: Open the merge request or commit and click **Revert**. Merge the resulting revert commit.

The editor syncs the revert automatically, and your live site redeploys with the previous content.

## Collaborate in real time

Expand Down
18 changes: 18 additions & 0 deletions es/agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,24 @@ El agente es una herramienta de IA que crea solicitudes de extracción (pull req

Todos los cambios pasan por solicitudes de extracción (pull requests). El agente nunca realiza confirmaciones directamente en tu branch principal.

<div id="get-started">
## Empezar
</div>

1. Abre la página [Agent](https://app.mintlify.com/products/agent) en tu dashboard.
2. Instala la aplicación de GitHub de Mintlify en los repositorios con los que quieras que trabaje el agente.
3. Envía tu primera solicitud desde el panel del agente, desde Slack o abriendo una pull request en un repositorio conectado.
4. Revisa la pull request que abre el agente y fusiónala cuando estés listo.

<div id="how-the-agent-stays-safe">
## Cómo el agente se mantiene seguro
</div>

- Solo abre pull requests. El agente nunca realiza commits directamente en tu branch de despliegue.
- Solo accede a los repositorios que conectes a través de la aplicación de GitHub de Mintlify.
- Trata los repositorios que no son de documentación como de solo lectura, usándolos como contexto pero sin escribir en ellos.
- Requiere revisión humana y fusión antes de que cualquier cambio llegue a tu sitio en vivo.

<div id="what-you-can-do-with-the-agent">
## Qué puedes hacer con el agente
</div>
Expand Down
15 changes: 13 additions & 2 deletions es/agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,17 @@ Si necesitas volver a autorizar el agente —por ejemplo, para otorgarle nuevos

Cuando reinstalas el agente en un espacio de trabajo que ya está conectado a tu organización, Mintlify actualiza en su lugar el bot token almacenado. Tus canales e hilos existentes se conservan intactos.

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

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

1. En Slack, ve a **Settings & administration > Manage apps** y abre la app `mintlify`.
2. Haz clic en **Remove app** para desinstalarla del espacio de trabajo.

Después de eliminarla, el agente deja de responder a menciones y mensajes directos. El historial de hilos existente permanece en Slack, pero el agente no puede acceder a él. Reinstala la app desde tu panel de Mintlify para volver a conectarla.

<Tip>
Si tu organización tiene múltiples despliegues, el agente te pide que elijas con cuál despliegue trabajar la primera vez que envías una solicitud.

Expand All @@ -66,8 +77,8 @@ conversación para que puedas continuar donde lo dejaste con el nuevo despliegue

Una vez conectado, puedes:

- Enviar mensajes directos al agente para usarlo en privado y actualizar tu documentación.
- Mencionar `@mintlify` en un canal para usarlo de forma pública y colaborativa.
- Enviar mensajes directos al agente para usarlo en privado y actualizar tu documentación. Los mensajes directos funcionan en cuanto la app esté instalada.
- Mencionar `@mintlify` en un canal para usarlo de forma pública y colaborativa. El agente solo responde en los canales a los que ha sido invitado; ejecuta `/invite @mintlify` en un canal para añadirlo.
- Adjuntar archivos e imágenes directamente a tus mensajes para que el agente los procese y los incluya en tu documentación.
- Continuar las conversaciones en hilos para iterar sobre los cambios o hacer preguntas de seguimiento. El agente reutiliza los archivos, las imágenes y las reacciones con emoji compartidos previamente en el hilo como contexto para las solicitudes posteriores, por lo que no es necesario que los vuelvas a cargar.
- Compartir enlaces a solicitudes de extracción con el agente para actualizar la documentación relacionada.
Expand Down
15 changes: 15 additions & 0 deletions es/automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,21 @@ Cada ejecución muestra uno de los siguientes estados:

Haz clic en una ejecución individual para ver su prompt, los archivos que leyó o modificó y cualquier pull request que haya abierto.

<div id="troubleshoot-a-failed-run">
### Solucionar una ejecución fallida
</div>

Si una ejecución muestra el estado **Failed**, ábrela desde la página [Automation Runs](https://app.mintlify.com/products/automations) para ver el prompt del agente, las llamadas a herramientas y la salida de error.

Causas comunes:

- Falta de acceso a un repositorio de contexto o de código fuente. Reinstala la [aplicación de GitHub de Mintlify](/es/deploy/github) en el repositorio afectado.
- Un token de integración revocado. Reconecta la integración en la página [Integraciones](https://app.mintlify.com/settings/organization/integrations).
- Un `docs.json` inválido o un error de validación en el repositorio del proyecto.
- Una programación o un activador que se dispara antes de que finalice la ejecución anterior.

Después de resolver el problema subyacente, haz clic en el botón de ejecución <Icon icon="play" /> junto a la automatización para volver a intentarlo. Las ejecuciones fallidas no cuentan para tu límite diario de ejecuciones, por lo que los reintentos son seguros.

<div id="continue-a-run-in-the-editor">
## Continuar una ejecución en el editor
</div>
Expand Down
2 changes: 2 additions & 0 deletions es/automations/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ keywords: ["predefinida", "automatización", "predeterminada"]

Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de documentación más comunes. Cada automatización tiene un prompt base y una configuración predeterminada. Puedes personalizar el activador, el modo de actualización y las instrucciones desde la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard.

Si ninguna de las automatizaciones predefinidas se ajusta a tu caso de uso, consulta [Crear una automatización personalizada](/es/automations/create) para definir tu propio prompt, activador y repositorios de contexto.

<div id="at-a-glance">
## De un vistazo
</div>
Expand Down
2 changes: 2 additions & 0 deletions es/create/changelogs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Consulta el [registro de cambios de Mintlify](/es/changelog) como ejemplo: en ca
Añade un `Update` para cada entrada del registro.

Incluye información relevante como lanzamientos de funcionalidades, correcciones de errores u otros anuncios.

Las entradas aparecen en el orden en que las listes en el archivo. Añade las nuevas entradas al principio del archivo para mostrar primero las actualizaciones más recientes.
</Step>
</Steps>

Expand Down
10 changes: 10 additions & 0 deletions es/deploy/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,16 @@ Usa esta comparación para elegir el método que se adapte a tu caso de uso. Con
</Tab>
</Tabs>

<div id="test-your-configuration">
### Prueba tu configuración
</div>

Antes de compartir la URL con los usuarios, verifica que la autenticación funcione como se espera:

- **Preview deployments**: Los [preview deployments](/es/deploy/preview-deployments) respetan la misma configuración de autenticación que tu sitio de producción. Envía una rama y abre la URL de vista previa para confirmar que el flujo de inicio de sesión funciona de principio a fin.
- **Prueba con una cuenta real**: Inicia sesión con un usuario de prueba o con un miembro de cada grupo que deba tener acceso, y confirma que las páginas restringidas aparecen o se ocultan como corresponde.
- **Desarrollo local**: `mint dev` sirve tu sitio sin aplicar la autenticación para que puedas iterar sobre el contenido. Verifica siempre las reglas de acceso contra un preview o un despliegue de producción, no contra el servidor local.

<div id="make-pages-public">
## Hacer públicas las páginas
</div>
Expand Down
11 changes: 11 additions & 0 deletions es/deploy/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,17 @@ El archivo exportado contiene todo lo necesario para ver tu documentación sin c
| `Start Docs.command` | Lanzador para macOS—haz doble clic para abrir la documentación |
| `Start Docs.bat` | Lanzador para Windows—haz doble clic para abrir la documentación |

<div id="feature-support">
### Compatibilidad de funciones
</div>

El archivo exportado es un paquete estático, por lo que las funciones que dependen de los servicios en la nube de Mintlify no están disponibles sin conexión:

- **Compatible sin conexión**: Navegación por páginas, imágenes, ejemplos de código, diagramas Mermaid y otro contenido pre-renderizado.
- **No compatible sin conexión**: Búsqueda de texto completo, el asistente de IA, el playground interactivo de la API, la analítica, los widgets de comentarios y la autenticación.

Los destinatarios que necesiten estas funciones deben acceder a tu sitio en producción.

<div id="view-the-exported-docs">
## Ver la documentación exportada
</div>
Expand Down
20 changes: 19 additions & 1 deletion es/editor/branching-and-publishing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,25 @@ Al publicar, puede introducir un mensaje de commit antes de confirmar. Si lo dej

Los conflictos ocurren cuando su branch y la deployment branch tienen cambios incompatibles en los mismos archivos. Por ejemplo, cuando usted y un compañero de equipo han editado las mismas líneas en un archivo o han movido un archivo a ubicaciones diferentes.

El editor muestra una advertencia cuando los conflictos bloquean la publicación. Siga las indicaciones para elegir qué versión de cada sección en conflicto conservar.
El editor muestra una advertencia cuando los conflictos bloquean la publicación. Para resolverlos:

1. Abra la advertencia de conflictos en el menú de publicación para ver la lista de archivos en conflicto.
2. Haga clic en un archivo para abrirlo. El editor muestra sus cambios junto a los cambios entrantes de la deployment branch.
3. Para cada conflicto, elija **Keep mine**, **Keep theirs**, o edite la sección manualmente para combinar ambos.
4. Guarde el archivo para eliminar el conflicto y vuelva a publicar.

<div id="revert-a-published-change">

## Revertir un cambio publicado

</div>

Para deshacer un cambio después de haberlo publicado, revierta el commit en su proveedor de Git:

- **GitHub**: Abra la pull request fusionada o el commit en el repositorio y haga clic en **Revert**. Fusione la pull request de revert para publicar la reversión.
- **GitLab**: Abra la merge request o el commit y haga clic en **Revert**. Fusione el commit de revert resultante.

El editor sincroniza el revert automáticamente y su sitio en vivo se vuelve a desplegar con el contenido anterior.

<div id="collaborate-in-real-time">

Expand Down
23 changes: 23 additions & 0 deletions es/optimize/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,29 @@ Consulta los comentarios en la página de Analytics en tu dashboard.
/>
</Frame>

<div id="enable-feedback">
## Habilitar comentarios
</div>

1. Ve a la página [Add-ons](https://app.mintlify.com/products/addons) en tu dashboard.
2. Activa los tipos de comentarios que quieras recopilar.
3. Guarda los cambios.

Después de habilitar los comentarios, los widgets correspondientes aparecen en tu sitio publicado y los envíos empiezan a llegar a la pestaña de comentarios.

<div id="how-readers-submit-feedback">
## Cómo envían comentarios los lectores
</div>

Los lectores envían comentarios directamente en tu sitio publicado:

- **Valoración con pulgares**: Los botones de pulgar arriba y pulgar abajo aparecen al final de cada página.
- **Comentarios contextuales**: Los lectores abren el menú contextual en una página para dejar comentarios de texto libre.
- **Comentarios sobre fragmentos de código**: Los lectores pasan el cursor sobre un bloque de código para reaccionar o comentar sobre el fragmento.
- **Sugerir ediciones y crear issues**: Los enlaces desde la página abren una pull request o un issue precompletado en tu repositorio de GitHub.

Los envíos aparecen en el [dashboard de comentarios](https://app.mintlify.com/products/analytics/v2/feedback) en cuanto se reciben.

<div id="feedback-types">
## Tipos de comentarios
</div>
Expand Down
Loading
Loading