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
17 changes: 14 additions & 3 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@
- **Plans**: Creates a structured task list for complex documentation work.
- **Writes**: Generates or updates content following writing standards and best practices.
- **Validates**: Runs Mintlify CLI checks to ensure documentation builds correctly.
- **Creates a PR**: Opens a pull request with proposed changes for review.

All changes go through pull requests. The agent never commits directly to your main branch.
- **Publishes changes**: Opens a pull request with proposed changes for review, or commits directly to your deploy branch, depending on your [review process setting](#choose-how-the-agent-publishes-changes).

## What you can do with the agent

Expand All @@ -36,6 +34,19 @@

By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://app.mintlify.com/settings/account) page of the dashboard.

## Choose how the agent publishes changes

By default, the agent opens a pull request for every change so your team can review it before it ships. If your deployment is hosted by Mintlify, the agent commits changes directly to your deploy branch so they publish immediately.

Check warning on line 39 in agent/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/index.mdx#L39

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

For deployments connected to your own Git provider, you can change how the agent publishes changes in the **Review process** setting on the [Agent](https://app.mintlify.com/products/agent) page of your dashboard:

- **Create a pull request**: The agent commits to a new branch and opens a pull request against your deploy branch. Use this option when you want a human to review changes before they publish.
- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging deployment.

<Note>
If your deploy branch has branch protection rules that block direct pushes, the **Review process** setting is hidden and the agent always opens a pull request.

Check warning on line 47 in agent/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/index.mdx#L47

In general, use active voice instead of passive voice ('is hidden').
</Note>

## Connect repositories as context

The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).
Expand Down
6 changes: 3 additions & 3 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@

Example questions:
- "Which pages mention the API rate limit?"
- "How do I set up authentication?"

Check warning on line 78 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L78

Avoid first-person pronouns such as ' I '.
- "How is our navigation structured?"

## Update documentation
Expand All @@ -86,7 +86,7 @@
- **Existing thread**: Reply in the thread and mention `@mintlify` with instructions on what to update.
- **With attachments**: Upload images, diagrams, code files, or other documents with your message. The agent automatically processes and includes them in your documentation. In a thread, the agent has access to images and files shared in earlier messages, so you can reference them in follow-up requests without reuploading.

The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates.
The agent reads the context of the request or thread and updates your connected repository. Depending on your [review process setting](/agent/index#choose-how-the-agent-publishes-changes), the agent either opens a pull request or commits directly to your deploy branch.

## Reference other repositories

Expand All @@ -100,7 +100,7 @@
- "Document the new endpoints added in `acme/backend#1234`."
- "What repositories do you have access to?"

The agent treats cloned repositories as read-only. It uses them for context, but always opens pull requests against your documentation repository.
The agent treats cloned repositories as read-only. It uses them for context, but only writes changes to your documentation repository.

## Track progress in real time

Expand All @@ -111,7 +111,7 @@
- **Questions**: If the agent needs more information, it presents options for you to select from or reply in the thread with a custom answer.
- **Permission requests**: Before the agent runs a third-party action that writes data, such as sending an email or creating a ticket, it asks you to approve or deny the action. The permission request is only visible to the person who triggered the request. Click **Approve** to let the agent proceed or **Deny** to cancel the action.
- **Interruptions**: If you send a follow-up message while the agent is still working, it stops the current task and starts on the new one.
- **Completion**: When the agent finishes, it posts a summary with a link to the pull request and a link to open the changes in the web editor.
- **Completion**: When the agent finishes, it posts a summary with a link to the pull request or commit and a link to open the changes in the web editor.

## Roles and permissions

Expand Down
19 changes: 16 additions & 3 deletions es/agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ El agente es una herramienta de IA que crea solicitudes de extracción (pull req
* **Planifica**: Crea una lista de tareas estructurada para trabajos de documentación complejos.
* **Escribe**: Genera o actualiza contenido siguiendo los estándares y las mejores prácticas de redacción.
* **Valida**: Ejecuta comprobaciones con Mintlify CLI para asegurarse de que la documentación se compile correctamente.
* **Crea una PR**: Abre una solicitud de extracción con cambios propuestos para revisión.

Todos los cambios pasan por solicitudes de extracción (pull requests). El agente nunca realiza confirmaciones directamente en tu branch principal.
* **Publica los cambios**: Abre una solicitud de extracción con los cambios propuestos para revisión, o realiza confirmaciones directamente en tu branch de despliegue, según tu [ajuste de proceso de revisión](/es/agent/index#choose-how-the-agent-publishes-changes).

<div id="what-you-can-do-with-the-agent">
## Qué puedes hacer con el agente
Expand All @@ -38,6 +36,21 @@ Usa el agente para:

De forma predeterminada, el agente abre solicitudes de extracción a nombre del bot de Mintlify. Para que las solicitudes de extracción se atribuyan a ti, conecta tu cuenta de GitHub en la página [Mi perfil](https://dashboard.mintlify.com/settings/account) del dashboard.

<div id="choose-how-the-agent-publishes-changes">
## Elige cómo publica los cambios el agente
</div>

De forma predeterminada, el agente abre una solicitud de extracción para cada cambio, de modo que tu equipo pueda revisarla antes de que se publique. Si Mintlify aloja tu despliegue, el agente realiza confirmaciones directamente en tu branch de despliegue para que se publiquen de inmediato.

Para los despliegues conectados a tu propio proveedor de Git, puedes cambiar cómo publica los cambios el agente en el ajuste **Review process** de la página [Agent](https://app.mintlify.com/products/agent) del dashboard:

- **Create a pull request**: El agente realiza confirmaciones en un branch nuevo y abre una solicitud de extracción contra tu branch de despliegue. Usa esta opción cuando quieras que una persona revise los cambios antes de que se publiquen.
- **Push to main**: El agente realiza confirmaciones directamente en tu branch de despliegue, y los cambios se publican en cuanto el agente termina. Usa esta opción cuando confíes en que el agente publique sin revisión, por ejemplo en un despliegue de staging.

<Note>
Si tu branch de despliegue tiene reglas de protección de branch que bloquean los envíos directos, el ajuste **Review process** se oculta y el agente siempre abre una solicitud de extracción.
</Note>

<div id="connect-repositories-as-context">
## Conecta repositorios como contexto
</div>
Expand Down
6 changes: 3 additions & 3 deletions es/agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Utiliza el agente para actualizar tu documentación mediante una nueva solicitud
- **Hilo existente**: Responde en el hilo y menciona `@mintlify` con instrucciones sobre qué actualizar.
- **Con archivos adjuntos**: Sube imágenes, diagramas, archivos de código u otros documentos junto con tu mensaje. El agente los procesa automáticamente y los incluye en tu documentación. En un hilo, el agente tiene acceso a las imágenes y archivos compartidos en mensajes anteriores, por lo que puedes hacer referencia a ellos en las solicitudes posteriores sin necesidad de volver a subirlos.

El agente lee el contexto de la solicitud o del hilo y crea una solicitud de extracción en tu repositorio conectado con las actualizaciones.
El agente lee el contexto de la solicitud o del hilo y actualiza tu repositorio conectado. Según tu [ajuste de proceso de revisión](/es/agent/index#choose-how-the-agent-publishes-changes), el agente abre una solicitud de extracción o realiza confirmaciones directamente en tu branch de despliegue.

<div id="reference-other-repositories">
## Hacer referencia a otros repositorios
Expand All @@ -112,7 +112,7 @@ Ejemplos de prompts:
- "Documenta los nuevos endpoints añadidos en `acme/backend#1234`."
- "¿A qué repositorios tienes acceso?"

Los repositorios clonados son de solo lectura. El agente los utiliza como contexto, pero siempre abre solicitudes de extracción contra tu repositorio de documentación.
Los repositorios clonados son de solo lectura. El agente los utiliza como contexto, pero solo escribe cambios en tu repositorio de documentación.

<div id="track-progress-in-real-time">
## Sigue el progreso en tiempo real
Expand All @@ -125,7 +125,7 @@ Mientras el agente trabaja en tu solicitud, proporciona retroalimentación en vi
- **Preguntas**: Si el agente necesita más información, presenta opciones para que selecciones o respondas en el hilo con una respuesta personalizada.
- **Solicitudes de permiso**: Antes de que el agente ejecute una acción de terceros que escribe datos, como enviar un correo o crear un ticket, te pide que apruebes o rechaces la acción. La tarjeta de aprobación se envía como un mensaje efímero visible solo para ti, la persona que activó la solicitud, para no interrumpir a otros participantes del hilo. Haz clic en **Approve** para que el agente continúe o en **Deny** para cancelar la acción.
- **Interrupciones**: Si envías un mensaje de seguimiento mientras el agente aún está trabajando, detiene la tarea actual y comienza con la nueva.
- **Finalización**: Cuando el agente termina, publica un resumen con un enlace a la solicitud de extracción y un enlace para abrir los cambios en el editor web.
- **Finalización**: Cuando el agente termina, publica un resumen con un enlace a la solicitud de extracción o al commit y un enlace para abrir los cambios en el editor web.

<div id="roles-and-permissions">
## Roles y permisos
Expand Down
19 changes: 16 additions & 3 deletions fr/agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ L'agent est un outil d'IA qui crée des pull requests (demandes de fusion) avec
* **Planifie** : crée une liste de tâches structurée pour les travaux de documentation complexes.
* **Rédige** : génère ou met à jour du contenu en suivant les standards de rédaction et les bonnes pratiques.
* **Valide** : exécute les vérifications de l'Interface en ligne de commande (CLI) Mintlify pour s'assurer que la documentation se génère correctement.
* **Crée une PR** : ouvre une pull request (demande de fusion) avec les modifications proposées pour relecture.

Tous les changements passent par des pull requests (demandes de fusion). L'agent ne fait jamais de commit directement sur votre branche principale.
* **Publie les modifications** : ouvre une pull request (demande de fusion) avec les modifications proposées pour relecture, ou pousse les modifications directement sur votre branche de déploiement, selon votre [paramètre de processus de relecture](/fr/agent/index#choose-how-the-agent-publishes-changes).

<div id="what-you-can-do-with-the-agent">
## Ce que vous pouvez faire avec l’agent
Expand All @@ -38,6 +36,21 @@ Utilisez l’agent pour :

Par défaut, l'agent ouvre des pull requests (demandes de fusion) attribuées au bot Mintlify. Pour que les pull requests vous soient attribuées, connectez votre compte GitHub depuis la page [My profile](https://dashboard.mintlify.com/settings/account) du Dashboard.

<div id="choose-how-the-agent-publishes-changes">
## Choisissez comment l'agent publie les modifications
</div>

Par défaut, l'agent ouvre une pull request pour chaque modification afin que votre équipe puisse la relire avant sa mise en ligne. Si Mintlify héberge votre déploiement, l'agent pousse les modifications directement sur votre branche de déploiement pour qu'elles soient publiées immédiatement.

Pour les déploiements connectés à votre propre fournisseur Git, vous pouvez modifier la façon dont l'agent publie les modifications dans le paramètre **Review process** de la page [Agent](https://app.mintlify.com/products/agent) de votre Dashboard :

- **Create a pull request** : L'agent pousse ses commits sur une nouvelle branche et ouvre une pull request contre votre branche de déploiement. Utilisez cette option lorsque vous souhaitez qu'une personne relise les modifications avant leur mise en ligne.
- **Push to main** : L'agent pousse ses commits directement sur votre branche de déploiement, et les modifications sont publiées dès que l'agent a terminé. Utilisez cette option lorsque vous faites confiance à l'agent pour publier sans relecture, par exemple sur un déploiement de staging.

<Note>
Si votre branche de déploiement est protégée par des règles qui bloquent les push directs, le paramètre **Review process** est masqué et l'agent ouvre toujours une pull request.
</Note>

<div id="connect-repositories-as-context">
## Connecter des dépôts en tant que contexte
</div>
Expand Down
6 changes: 3 additions & 3 deletions fr/agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Utilisez l'agent pour mettre à jour votre documentation au moyen d'une nouvelle
- **Fil existant** : Répondez dans le fil et mentionnez `@mintlify` avec des instructions sur ce qu'il faut mettre à jour.
- **Avec des pièces jointes** : Téléversez des images, des diagrammes, des fichiers de code ou d'autres documents avec votre message. L'agent les traite automatiquement et les inclut dans votre documentation. Dans un fil, l'agent a accès aux images et fichiers partagés dans les messages précédents, vous pouvez donc y faire référence dans les demandes suivantes sans avoir à les téléverser à nouveau.

L'agent lit le contexte de la demande ou du fil et crée une pull request (demande de fusion) dans votre référentiel connecté avec les mises à jour.
L'agent lit le contexte de la demande ou du fil et met à jour votre référentiel connecté. Selon votre [paramètre de processus de relecture](/fr/agent/index#choose-how-the-agent-publishes-changes), l'agent ouvre une pull request (demande de fusion) ou pousse les modifications directement sur votre branche de déploiement.

<div id="reference-other-repositories">
## Référencer d'autres dépôts
Expand All @@ -113,7 +113,7 @@ Exemples de prompts :
- « Documentez les nouveaux endpoints ajoutés dans `acme/backend#1234`. »
- « À quels dépôts avez-vous accès ? »

Les dépôts clonés sont en lecture seule. L'agent les utilise comme contexte, mais ouvre toujours des pull requests (demandes de fusion) sur votre dépôt de documentation.
Les dépôts clonés sont en lecture seule. L'agent les utilise comme contexte, mais n'écrit des modifications que dans votre dépôt de documentation.

<div id="track-progress-in-real-time">
## Suivez la progression en temps réel
Expand All @@ -126,7 +126,7 @@ Pendant que l'agent travaille sur votre demande, il fournit un retour en direct
- **Questions** : Si l'agent a besoin de plus d'informations, il présente des options parmi lesquelles vous pouvez choisir ou vous pouvez répondre dans le fil avec une réponse personnalisée.
- **Demandes d'autorisation** : Avant que l'agent n'exécute une action tierce qui écrit des données, comme envoyer un e-mail ou créer un ticket, il vous demande d'approuver ou de refuser l'action. La carte d'approbation est envoyée sous forme de message éphémère visible uniquement par vous, la personne qui a déclenché la demande, afin de ne pas interrompre les autres participants du fil. Cliquez sur **Approve** pour laisser l'agent continuer ou sur **Deny** pour annuler l'action.
- **Interruptions** : Si vous envoyez un message de suivi pendant que l'agent travaille encore, il arrête la tâche en cours et commence la nouvelle.
- **Achèvement** : Lorsque l'agent a terminé, il publie un résumé avec un lien vers la pull request (demande de fusion) et un lien pour ouvrir les modifications dans l'éditeur web.
- **Achèvement** : Lorsque l'agent a terminé, il publie un résumé avec un lien vers la pull request (demande de fusion) ou le commit et un lien pour ouvrir les modifications dans l'éditeur web.

<div id="roles-and-permissions">
## Rôles et autorisations
Expand Down
19 changes: 16 additions & 3 deletions zh/agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ agent 是一款 AI 工具,会根据你的提示,为文档创建包含建议
* **规划**:为复杂的文档工作创建结构化任务清单。
* **撰写**:生成或更新内容,遵循写作规范和最佳实践。
* **验证**:运行 Mintlify 命令行界面 (CLI) 检查,确保文档可以正确构建。
* **创建 PR**:打开一个包含建议更改的拉取请求 (PR;亦称“合并请求”/Merge Request) ,供你审核。

所有更改都会通过拉取请求完成。agent 永远不会直接向你的主 branch 进行提交。
* **发布更改**:打开一个包含建议更改的拉取请求 (PR;亦称“合并请求”/Merge Request) 供你审核,或直接向你的部署 branch 提交,具体取决于你的[审核流程设置](/zh/agent/index#choose-how-the-agent-publishes-changes)。

<div id="what-you-can-do-with-the-agent">
## 你可以用智能助手做什么
Expand All @@ -38,6 +36,21 @@ agent 是一款 AI 工具,会根据你的提示,为文档创建包含建议

默认情况下,代理会以 Mintlify 机器人身份创建拉取请求 (PR;亦称“合并请求”/Merge Request) 。若要将拉取请求归属到你的账号,请在控制台的 [My profile](https://dashboard.mintlify.com/settings/account) 页面连接你的 GitHub 账户。

<div id="choose-how-the-agent-publishes-changes">
## 选择 agent 如何发布更改
</div>

默认情况下,agent 会为每次更改打开一个拉取请求,以便你的团队在更改发布前进行审核。如果你的部署由 Mintlify 托管,agent 会将更改直接提交到你的部署 branch,使其立即发布。

对于连接到你自有 Git 提供商的部署,你可以在控制台 [Agent](https://app.mintlify.com/products/agent) 页面的 **Review process** 设置中更改 agent 发布更改的方式:

- **Create a pull request**:agent 在新的 branch 上提交更改,并针对你的部署 branch 打开拉取请求。当你希望有人在更改发布前进行审核时,请使用此选项。
- **Push to main**:agent 直接向你的部署 branch 提交更改,agent 完成后更改立即发布。当你信任 agent 无需审核即可发布时(例如在预发布环境的部署中),请使用此选项。

<Note>
如果你的部署 branch 设置了阻止直接推送的分支保护规则,**Review process** 设置会被隐藏,agent 将始终打开拉取请求。
</Note>

<div id="connect-repositories-as-context">
## 将仓库连接为上下文
</div>
Expand Down
Loading
Loading