diff --git a/es/ai/agent.mdx b/es/ai/agent.mdx index e36cd1e00..608ce5855 100644 --- a/es/ai/agent.mdx +++ b/es/ai/agent.mdx @@ -24,16 +24,16 @@ Para empezar, agrega el agente a tu espacio de trabajo de Slack y menciónalo co - Si el propietario del espacio de trabajo de Slack requiere aprobación de administrador para instalar aplicaciones, pídele que apruebe la aplicación de Mintlify antes de conectarla. + Si el propietario del espacio de trabajo de Slack requiere aprobación de un administrador para instalar aplicaciones, pídeles que aprueben la aplicación de Mintlify antes de conectarla. -1. Ve a la página del [agente](https://dashboard.mintlify.com/products/agent) en tu dashboard. +1. Ve a la página del [agent](https://dashboard.mintlify.com/products/agent) en tu dashboard. 2. Selecciona el botón **Connect**. 3. Sigue las indicaciones de Slack para agregar la aplicación `mintlify` a tu espacio de trabajo. 4. Sigue las indicaciones de Slack para vincular tu cuenta de Mintlify con tu espacio de trabajo de Slack. -5. Prueba que el agente funciona y responde cuando: - * Le envías un mensaje directo. - * Lo mencionas con `@mintlify` en un canal. +5. Verifica que el agente esté funcionando y responda cuando: + * Le envíes un mensaje directo. + * Lo menciones con `@mintlify` en un canal.
## Conecta repositorios como contexto @@ -42,22 +42,28 @@ Para empezar, agrega el agente a tu espacio de trabajo de Slack y menciónalo co El agente solo puede acceder a los repositorios que conectes mediante la Aplicación de GitHub de Mintlify. Modifica qué repositorios puede acceder el agente en la [configuración de la Aplicación de GitHub](https://github.com/apps/mintlify/installations/new).
- ## Integrar el agente mediante la API + ## Integra el agente mediante la API
-Los endpoints del agente pueden usarse para [crear trabajos](/es/api-reference/agent/create-agent-job), [obtener un trabajo específico](/es/api-reference/agent/get-agent-job) y [obtener todos los trabajos](/es/api-reference/agent/get-all-jobs). +Usa los endpoints del agente para [crear tareas](/es/api-reference/agent/create-agent-job), [obtener una tarea específica](/es/api-reference/agent/get-agent-job) y [obtener todas las tareas](/es/api-reference/agent/get-all-jobs).
## Escribe prompts efectivos
-Piensa en el agente como un assistant útil que necesita tu guía para completar tareas. Dale instrucciones claras y contexto. Las tareas más enfocadas son más fáciles de completar, así que divide los proyectos complejos en pasos más pequeños. +Piensa en el agente como un assistant útil que necesita tu guía para completar tareas. Dale instrucciones claras y contexto. Las tareas más específicas son más fáciles de completar, así que divide los proyectos complejos en pasos más pequeños. -Haz que tus prompts sean específicos y orientados a resultados. Prompts genéricos como `@mintlify Improve the onboarding page` aplican buenas prácticas generales, pero puede que no mejoren el contenido exactamente como lo tenías en mente. +Haz que tus prompts sean concretos y orientados a resultados. Prompts genéricos como `@mintlify Improve the onboarding page` aplican buenas prácticas generales, pero puede que no mejoren el contenido exactamente como lo imaginabas. -Prueba prompts basados en los resultados que quieres que tus usuarios consigan o en los problemas que encuentran. Por ejemplo: `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` o `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key`. +Prueba prompts basados en los resultados que quieres que tus usuarios alcancen o en los problemas que enfrentan. Por ejemplo: -Usa prompts amplios para el mantenimiento general del contenido, como corregir errores tipográficos, actualizar redirecciones o renombrar una función en toda tu documentación. Por ejemplo: `@mintlify Find and fix all typos in the docs` o `@mintlify change all unordered lists to use * instead of -`. +* `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` +* `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key` + +Usa prompts amplios para el mantenimiento general del contenido, como corregir errores tipográficos, actualizar redirecciones o renombrar una función en toda tu documentación. Por ejemplo: + +* `@mintlify Find and fix all typos in the docs` +* `@mintlify change all unordered lists to use * instead of -`
## Flujos de trabajo del agente @@ -66,46 +72,60 @@ Usa prompts amplios para el mantenimiento general del contenido, como corregir e El agente ayuda con muchas tareas de documentación. Estos flujos de trabajo muestran algunas de las maneras en que puedes integrar al agente en tu proceso de documentación. Prueba un enfoque que se adapte a la forma en que trabaja tu equipo actualmente y ajústalo a tus necesidades específicas.
- ### Itera sobre un prompt en un hilo de Slack + ### Iterar un prompt en un hilo de Slack
-Haz un prompt al agente y luego sigue mencionándolo con `@mintlify` en el mismo hilo para refinar e iterar la solicitud de extracción que crea. Por ejemplo: `@mintlify Nuestra página de inicio rápido necesita una nueva sección sobre cómo invitar colaboradores`. Luego: `@mintlify La nueva sección debería llamarse "Invitar colaboradores"`. Y continúa con cualquier otra iteración. +Envía un prompt al agente y sigue mencionándolo con `@mintlify` en el mismo hilo para refinar e iterar la solicitud de extracción que cree. + +Por ejemplo: `@mintlify Nuestra página de inicio rápido necesita una nueva sección sobre cómo invitar colaboradores`. Luego: `@mintlify La nueva sección debería llamarse "Invitar colaboradores"`. Y continúa con cualquier otra iteración.
- ### Comienza con el agente, termina manualmente + ### Empieza con el agente y termina manualmente
-Pídele al agente que inicie un proyecto, luego cambia a la branch que cree y termina la tarea en tu entorno local o en el editor web. El agente puede ayudarte a empezar; después, puedes tomar el control para completar la tarea. Por ejemplo: `@mintlify Update the quickstart page to include information about inviting collaborators`, y luego cambia a la branch para realizar cualquier cambio adicional usando tu método preferido. +Pídele al agente que inicie un proyecto, luego cambia a la branch que cree y completa la tarea en tu entorno local o en el editor web. El agente puede ayudarte a comenzar; después, puedes retomar para finalizar la tarea. + +Por ejemplo: `@mintlify Update the quickstart page to include information about inviting collaborators`, y luego cambia a la branch para realizar cualquier cambio adicional con tu método preferido.
### Actualiza la documentación al fusionar cambios de funcionalidades
-Cuando fusiones una solicitud de extracción de una funcionalidad, comparte el enlace del PR con el agente para actualizar la documentación pertinente. Por ejemplo: `@mintlify Este PR agrega un nuevo método de autenticación. Actualiza la documentación para incluir el nuevo flujo de auth: [enlace al PR]`. +Cuando fusiones una solicitud de extracción de una funcionalidad, comparte el enlace del PR con el agente para actualizar la documentación correspondiente. + +Por ejemplo: `@mintlify Este PR agrega un nuevo método de autenticación. Actualiza la documentación para incluir el nuevo flujo de autenticación: [enlace al PR]`.
- ### Generar notas de versión a partir del historial de confirmaciones + ### Genera notas de la versión a partir del historial de confirmaciones
-Pídele al agente una solicitud de extracción específica o un período de tiempo para generar notas de versión o actualizaciones del changelog basadas en el historial de confirmaciones. Por ejemplo: `@mintlify Generate release notes for this PR: [PR link]` o `@mintlify Generate release notes for the last month`. +Indícale al agente una solicitud de extracción específica o un período de tiempo para generar notas de la versión o actualizaciones del changelog basadas en el historial de confirmaciones. + +Por ejemplo: `@mintlify Generate release notes for this PR: [PR link]` o `@mintlify Generate release notes for the last month`.
### Generar ejemplos de código
-Pídele al agente que genere ejemplos de código para funcionalidades a lo largo de tu documentación o en páginas específicas. Por ejemplo: `@mintlify Genera un ejemplo de código para que el método de autenticación sea más fácil de entender`. +Pídele al agente que genere ejemplos de código para funciones en toda tu documentación o en páginas específicas. + +Por ejemplo: `@mintlify Genera un ejemplo de código para que el método de Autenticación sea más fácil de entender`.
### Revisar el contenido existente
-Pídele al agente que revise el contenido existente para verificar la precisión técnica, el estilo, la gramática u otros problemas. Por ejemplo: `@mintlify Revisa la sección de limitación de tasa de la API. Cambiamos los límites el mes pasado`. +Pídele al agente que revise el contenido existente para verificar la precisión técnica, el estilo, la gramática u otros aspectos. + +Por ejemplo: `@mintlify Revisa la sección de limitación de tasa de la API. Cambiamos los límites el mes pasado`.
### Responder a los comentarios de los usuarios
-Proporciona al agente comentarios de tus usuarios para aplicar actualizaciones específicas en tu documentación. Por ejemplo: `@mintlify Los usuarios se están confundiendo con el paso 3 de la guía de configuración. ¿Qué puede estar generando la confusión?`. +Proporciona al agente comentarios de tus usuarios para realizar actualizaciones específicas en tu documentación. + +Por ejemplo: `@mintlify Los usuarios se están confundiendo con el paso 3 de la guía de configuración. ¿Qué podría estar causando la falta de claridad?`.
### Automatiza con la API diff --git a/fr/ai/agent.mdx b/fr/ai/agent.mdx index 8fb1665ec..0ecdd9bab 100644 --- a/fr/ai/agent.mdx +++ b/fr/ai/agent.mdx @@ -32,8 +32,8 @@ Pour commencer, ajoutez l’agent à votre espace de travail Slack et mentionnez 3. Suivez les instructions Slack pour ajouter l’application `mintlify` à votre espace de travail. 4. Suivez les instructions Slack pour lier votre compte Mintlify à votre espace de travail Slack. 5. Vérifiez que l’agent fonctionne et répond lorsque vous : - * Lui envoyez un message direct. - * Le mentionnez avec `@mintlify` dans un canal. + * lui envoyez un message direct ; + * le mentionnez avec `@mintlify` dans un canal.
## Connecter des dépôts comme contexte @@ -45,19 +45,25 @@ L’agent ne peut accéder qu’aux dépôts que vous connectez via la GitHub Ap ## Intégrer l’agent via l’API
-Les points de terminaison de l’API de l’agent permettent de [créer des tâches](/fr/api-reference/agent/create-agent-job), [récupérer une tâche spécifique](/fr/api-reference/agent/get-agent-job) et [récupérer toutes les tâches](/fr/api-reference/agent/get-all-jobs). +Utilisez les points de terminaison de l’agent pour [créer des tâches](/fr/api-reference/agent/create-agent-job), [récupérer une tâche spécifique](/fr/api-reference/agent/get-agent-job) et [récupérer toutes les tâches](/fr/api-reference/agent/get-all-jobs).
## Rédiger des prompts efficaces
-Considérez l’agent comme un assistant utile qui a besoin de vos indications pour accomplir des tâches. Donnez‑lui des instructions claires et du contexte. Les tâches ciblées sont plus faciles à mener à bien, donc décomposez les projets complexes en étapes plus petites. +Considérez l’agent comme un Assistant utile qui a besoin de vos indications pour accomplir des tâches. Donnez-lui des instructions claires et du contexte. Les tâches plus ciblées sont plus faciles à réaliser : décomposez donc les projets complexes en étapes plus petites. -Rendez vos prompts spécifiques et orientés vers le résultat. Des prompts génériques comme `@mintlify Improve the onboarding page` appliquent des bonnes pratiques générales, mais peuvent ne pas améliorer le contenu de la manière précise que vous aviez en tête. +Formulez des prompts spécifiques et orientés vers le résultat. Des prompts génériques comme `@mintlify Improve the onboarding page` appliquent des bonnes pratiques générales, mais peuvent ne pas améliorer le contenu de la manière précise que vous aviez en tête. -Essayez des prompts fondés sur les résultats que vous souhaitez que vos utilisateurs atteignent ou sur les problèmes qu’ils rencontrent. Par exemple : `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` ou `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key`. +Essayez des prompts basés sur les résultats que vous souhaitez que vos utilisateurs atteignent ou sur les problèmes qu’ils rencontrent. Par exemple : -Utilisez des prompts larges pour la maintenance générale du contenu, comme corriger les fautes de frappe, mettre à jour les redirections ou renommer une fonctionnalité dans l’ensemble de votre documentation. Par exemple : `@mintlify Find and fix all typos in the docs` ou `@mintlify change all unordered lists to use * instead of -`. +* `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` +* `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key` + +Utilisez des prompts plus larges pour la maintenance générale du contenu, comme corriger les fautes de frappe, mettre à jour les redirections ou renommer une fonctionnalité dans l’ensemble de votre documentation. Par exemple : + +* `@mintlify Find and fix all typos in the docs` +* `@mintlify change all unordered lists to use * instead of -`
## Workflows de l’agent @@ -66,46 +72,60 @@ Utilisez des prompts larges pour la maintenance générale du contenu, comme cor L’agent prend en charge de nombreuses tâches liées à la documentation. Ces workflows illustrent différentes manières d’intégrer l’agent à votre processus de documentation. Adoptez une approche qui correspond au fonctionnement actuel de votre équipe et adaptez-la à vos besoins spécifiques.
- ### Itérez sur un prompt dans un fil Slack + ### Itérer sur une invite dans un fil Slack
-Faites une première demande à l’agent, puis continuez à le mentionner avec `@mintlify` dans le même fil pour affiner et itérer sur la pull request (demande de fusion) qu’il crée. Par exemple : `@mintlify Notre page de démarrage rapide a besoin d’une nouvelle section sur l’invitation de collaborateurs`. Puis : `@mintlify La nouvelle section devrait s’intituler « Inviter des collaborateurs »`. Suivez avec toute autre itération nécessaire. +Envoyez une invite à l’agent, puis continuez à le mentionner avec `@mintlify` dans le même fil pour affiner et itérer sur la pull request (demande de fusion) qu’il crée. + +Par exemple : `@mintlify Notre page de démarrage rapide a besoin d’une nouvelle section sur l’invitation de collaborateurs`. Puis : `@mintlify La nouvelle section devrait s’appeler "Inviter des collaborateurs"`. Suivi de toute autre itération.
### Commencez avec l’agent, terminez manuellement
-Demandez à l’agent de lancer un projet, puis récupérez la branche qu’il crée et terminez la tâche dans votre environnement local ou dans l’éditeur web. L’agent peut vous aider à démarrer, puis vous pouvez prendre le relais pour finaliser la tâche. Par exemple : `@mintlify Update the quickstart page to include information about inviting collaborators`, puis récupérez la branche pour apporter des modifications supplémentaires avec votre méthode préférée. +Demandez à l’agent de lancer un projet, puis basculez vers la branche qu’il crée et terminez la tâche dans votre environnement local ou dans l’éditeur web. L’agent peut vous aider à démarrer, puis vous pouvez prendre le relais pour finaliser la tâche. + +Par exemple : `@mintlify Update the quickstart page to include information about inviting collaborators` puis basculez sur la branche pour apporter des modifications supplémentaires avec votre méthode préférée.
- ### Mettre à jour la documentation lors de la fusion de changements de fonctionnalités + ### Mettre à jour la documentation lors de la fusion de changements de fonctionnalité
-Lorsque vous fusionnez une pull request (demande de fusion) de fonctionnalité, partagez le lien de la PR avec l’agent pour mettre à jour la documentation concernée. Par exemple : `@mintlify Cette PR ajoute une nouvelle méthode d’authentification. Mettez à jour la doc pour inclure le nouveau flux d’authentification : [PR link]`. +Lorsque vous fusionnez une pull request de fonctionnalité, partagez le lien de la PR avec l’agent pour mettre à jour la documentation concernée. + +Par exemple : `@mintlify Cette PR ajoute une nouvelle méthode d’authentification. Mettez à jour la doc pour inclure le nouveau flux d’authentification : [lien de la PR]`.
### Générer des notes de version à partir de l’historique des commits
-Demandez à l’agent, en lui fournissant un pull request (demande de fusion) spécifique ou une période donnée, de générer des notes de version ou des mises à jour du journal des modifications à partir de l’historique des commits. Par exemple : `@mintlify Generate release notes for this PR: [PR link]` ou `@mintlify Generate release notes for the last month`. +Demandez à l’agent, à partir d’un pull request spécifique ou d’une période donnée, de générer des notes de version ou des mises à jour du journal des modifications à partir de l’historique des commits. + +Par exemple : `@mintlify Generate release notes for this PR: [PR link]` ou `@mintlify Generate release notes for the last month`.
### Générer des exemples de code
-Demandez à l’agent de générer des exemples de code pour des fonctionnalités dans l’ensemble de votre documentation ou sur des pages spécifiques. Par exemple : `@mintlify Génère un exemple de code pour rendre la méthode d’authentification plus facile à comprendre`. +Demandez à l’agent de générer des exemples de code pour des fonctionnalités dans l’ensemble de votre documentation ou sur des pages spécifiques. + +Par exemple : `@mintlify Génère un exemple de code pour rendre la méthode d’authentification plus facile à comprendre`.
### Passer en revue le contenu existant
-Demandez à l’agent de passer en revue le contenu existant pour vérifier l’exactitude technique, le style, la grammaire ou d’autres points. Par exemple : `@mintlify Review the API rate limiting section. We changed limits last month`. +Demandez à l’agent de vérifier le contenu existant pour en évaluer l’exactitude technique, le style, la grammaire ou d’autres problèmes. + +Par exemple : `@mintlify Review the API rate limiting section. We changed limits last month`.
- ### Répondre aux commentaires des utilisateurs + ### Répondre aux retours des utilisateurs
-Soumettez à l’agent les commentaires de vos utilisateurs pour apporter des mises à jour ciblées à votre documentation. Par exemple : `@mintlify Les utilisateurs sont déroutés par l’étape 3 du guide d’installation. Qu’est-ce qui pourrait la rendre ambiguë ?`. +Transmettez à l’agent les retours de vos utilisateurs pour apporter des mises à jour ciblées à votre documentation. + +Par exemple : `@mintlify Les utilisateurs se perdent à l’étape 3 du guide d’installation. Qu’est-ce qui pourrait la rendre peu claire ?`.
### Automatiser avec l’API diff --git a/zh/ai/agent.mdx b/zh/ai/agent.mdx index db4760663..d327813b8 100644 --- a/zh/ai/agent.mdx +++ b/zh/ai/agent.mdx @@ -24,15 +24,15 @@ Agent 会根据你的提示为文档提出修改并创建拉取请求（PR）。
- 如果你的 Slack 工作区所有者要求对安装应用进行管理员审批，请在连接之前请他们先批准 Mintlify 应用。 + 如果你的 Slack 工作区所有者要求安装应用需管理员批准，请在连接之前请他们先批准 Mintlify 应用。 -1. 前往你的控制台中的 [agent](https://dashboard.mintlify.com/products/agent) 页面。 +1. 前往控制台中的 [agent](https://dashboard.mintlify.com/products/agent) 页面。 2. 选择 **Connect** 按钮。 3. 按照 Slack 的提示将 `mintlify` 应用添加到你的工作区。 4. 按照 Slack 的提示将你的 Mintlify 账户与 Slack 工作区关联。 -5. 测试代理是否正常工作并在以下情况下做出响应： - * 向它发送一条私信。 +5. 测试代理是否正常工作并在以下情况下响应： + * 向其发送一条私信。 * 在频道中使用 `@mintlify` 提及它。
@@ -42,22 +42,28 @@ Agent 会根据你的提示为文档提出修改并创建拉取请求（PR）。 代理只能访问你通过 Mintlify GitHub 应用连接的仓库。你可以在 [GitHub 应用设置](https://github.com/apps/mintlify/installations/new) 中修改代理可访问的仓库。
- ## 通过 API 嵌入代理 + ## 通过 API 嵌入 Agent
-代理端点可用于[创建任务](/zh/api-reference/agent/create-agent-job)、[获取特定任务](/zh/api-reference/agent/get-agent-job)以及[获取所有任务](/zh/api-reference/agent/get-all-jobs)。 +使用 Agent 端点来[创建任务](/zh/api-reference/agent/create-agent-job)、[获取指定任务](/zh/api-reference/agent/get-agent-job)以及[获取全部任务](/zh/api-reference/agent/get-all-jobs)。
## 编写高效的提示词
-将代理视为一个需要你指引来完成任务的 AI 助手。向它提供清晰的指令和上下文。任务越聚焦，越容易完成，因此将复杂项目拆解为更小的步骤。 +将代理视为需要你指引来完成任务的 AI 助手。请提供清晰的指令和上下文。任务越聚焦越容易完成，因此把复杂项目拆解为更小的步骤。 -让你的提示词具体且以结果为导向。像 `@mintlify Improve the onboarding page` 这样的笼统提示只会应用通用最佳实践，但可能无法按你设想的方式改进内容。 +让你的提示词具体且以结果为导向。像 `@mintlify Improve the onboarding page` 这样的泛化提示会应用通用最佳实践，但可能无法按照你设想的方式针对性地改进内容。 -围绕你希望用户达成的目标或他们遇到的问题来编写提示词。例如：`@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` 或 `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key`。 +围绕你希望用户达成的结果或他们遇到的问题来设计提示词。例如： -对一般性的内容维护，使用更宽泛的提示词，例如修正错别字、更新重定向，或在整个文档中重命名某个功能。例如：`@mintlify Find and fix all typos in the docs` 或 `@mintlify change all unordered lists to use * instead of -`。 +* `@mintlify A lot of users have trouble installing the CLI. Review the onboarding page and update the docs so that users can easily install the CLI` +* `@mintlify Developers keep getting 401 errors when following our authentication guide. Review the auth docs and add clearer examples showing how to properly format the API key` + +对于修正错别字、更新重定向或在整个文档中重命名功能等常规内容维护，可以使用更宽泛的提示词。例如： + +* `@mintlify Find and fix all typos in the docs` +* `@mintlify change all unordered lists to use * instead of -`
## Agent 工作流 @@ -66,46 +72,60 @@ Agent 会根据你的提示为文档提出修改并创建拉取请求（PR）。 该 Agent 可协助处理多种文档任务。以下工作流展示了将 Agent 集成到文档流程中的一些方式。选择与团队当前工作方式相匹配的方法，并根据你的具体需求进行调整。
- ### 在 Slack 线程中迭代优化提示 + ### 在 Slack 线程中迭代优化提示词
-先向代理发送提示，然后在同一线程中继续用 `@mintlify` 提及它，以完善并迭代其创建的拉取请求（PR）。例如：`@mintlify 我们的快速入门页面需要新增一个关于邀请协作者的章节`。然后：`@mintlify 新章节应命名为「邀请协作者」`。之后可继续进行其他迭代。 +先向代理发送提示词，然后在同一线程中继续使用 `@mintlify` 提及它，以完善并迭代其创建的拉取请求（PR）。 + +例如：`@mintlify 我们的快速入门页面需要新增一个“邀请协作者”的章节`。然后：`@mintlify 新章节应命名为 "Inviting collaborators"`。之后可继续进行其他迭代。
- ### 由智能代理起步，手动收尾 + ### 从代理开始，手动收尾
-让代理启动一个项目，然后检出它创建的 branch，并在本地环境或网页版编辑器中完成任务。代理可助你快速起步，随后由你接手完成。示例：`@mintlify Update the quickstart page to include information about inviting collaborators`，接着检出该 branch，并用你偏好的方式进行后续修改。 +让代理启动一个项目，然后检出它创建的 branch，并在本地环境或网页版编辑器中完成任务。代理可帮助你起步，随后你可以接手收尾。 + +例如：`@mintlify Update the quickstart page to include information about inviting collaborators`，接着检出该 branch，按你偏好的方式进行后续修改。
- ### 合并功能变更时更新文档 + ### 合并功能改动时更新文档
-当你合并功能拉取请求（PR）后，将 PR 链接发给助手以更新相关文档。例如：`@mintlify 此 PR 新增了一种认证方法。请更新文档以包含新的认证流程：[PR 链接]`。 +当你合并功能拉取请求（PR）后，将该 PR 链接分享给代理，以便更新相关文档。 + +例如：`@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]`。
### 基于提交历史生成发布说明
-向代理提供特定的拉取请求（PR）或时间范围，以基于提交历史生成发布说明或更新日志。例如：`@mintlify Generate release notes for this PR: [PR link]` 或 `@mintlify Generate release notes for the last month`。 +向助手提供特定的拉取请求（PR）或时间范围，基于提交历史生成发布说明或更新日志。 + +例如：`@mintlify Generate release notes for this PR: [PR link]` 或 `@mintlify Generate release notes for the last month`。
### 生成代码示例
-让代理在你的文档各处或特定页面为功能生成代码示例。例如：`@mintlify 生成一个代码示例，以便更容易理解该认证方法`。 +让智能助手在你的文档各处或特定页面为功能生成代码示例。 + +例如：`@mintlify 生成一个代码示例，帮助更容易理解认证方法`。
### 审查现有内容
-让代理审查现有内容的技术准确性、风格、语法等问题。例如：`@mintlify Review the API rate limiting section. We changed limits last month`。 +让代理审查现有内容的技术准确性、风格、语法等方面的问题。 + +例如：`@mintlify Review the API rate limiting section. We changed limits last month`
- ### 回应用户反馈 + ### 响应用户反馈
-将用户的反馈作为提示提供给代理，以便对文档进行有针对性的更新。例如：`@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`。 +将用户的反馈提交给助手，以便对你的文档进行有针对性的更新。 + +例如：`@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`.
### 使用 API 实现自动化