diff --git a/docs.json b/docs.json index 272d69e7c..b73cd1705 100644 --- a/docs.json +++ b/docs.json @@ -463,6 +463,7 @@ "pages": [ "fr/agent/index", "fr/agent/slack", + "fr/agent/linear", "fr/agent/customize", "fr/agent/effective-prompts", "fr/agent/workflows" @@ -830,6 +831,7 @@ "pages": [ "es/agent/index", "es/agent/slack", + "es/agent/linear", "es/agent/customize", "es/agent/effective-prompts", "es/agent/workflows" @@ -1197,6 +1199,7 @@ "pages": [ "zh/agent/index", "zh/agent/slack", + "zh/agent/linear", "zh/agent/customize", "zh/agent/effective-prompts", "zh/agent/workflows" diff --git a/es/agent/index.mdx b/es/agent/index.mdx index c66bbfca1..1e694cf7a 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -24,7 +24,7 @@ Todos los cambios pasan por solicitudes de extracción (pull requests). El agent Usa el agente para: -* Escribir contenido nuevo basado en tus prompts, solicitudes de extracción, hilos de Slack o archivos adjuntos. +* Escribir contenido nuevo basado en tus prompts, solicitudes de extracción, issues de Linear, hilos de Slack o archivos adjuntos. * Actualizar documentación existente con nuevas funcionalidades o cambios en la API. * Procesar e incluir imágenes, diagramas y otros archivos a partir de archivos adjuntos de Slack. * Buscar y revisar ejemplos de código y referencias de API en toda tu documentación. @@ -53,6 +53,9 @@ El agente solo puede acceder a los repositorios que conectes mediante la Aplicac Añade el agente a tu espacio de trabajo de Slack. + + Añade el agente a tu espacio de trabajo de Linear. + Configura el agente con un archivo `AGENTS.md`. diff --git a/es/agent/linear.mdx b/es/agent/linear.mdx new file mode 100644 index 000000000..90848551c --- /dev/null +++ b/es/agent/linear.mdx @@ -0,0 +1,40 @@ +--- +title: "Añade el agente a Linear" +description: "Usa el agente en Linear para crear actualizaciones de documentación a partir de issues y comentarios." +keywords: ["issue tracking", "project management"] +--- + +Conecta tu espacio de trabajo de Linear al agente para realizar actualizaciones de documentación desde Linear. Cuando mencionas al agente de Mintlify en un comentario de Linear o le asignas un issue, el agente recopila contexto del issue y abre una solicitud de extracción con los cambios propuestos en tu documentación. + +
+ ## Conecta tu espacio de trabajo de Linear +
+ +1. Ve a la página de [Agent](https://dashboard.mintlify.com/products/agent) en tu dashboard. +2. En la sección "Agent settings", haz clic en **Install Linear app**. + + La sección de configuración de aplicaciones con los botones de instalación de Slack y Linear. + La sección de configuración de aplicaciones con los botones de instalación de Slack y Linear. + +3. Sigue las indicaciones de Linear para autorizar la aplicación de Mintlify en tu espacio de trabajo. + +
+ ## Usar el agente en Linear +
+ +Una vez conectado, menciona `@mintlify` en un issue de Linear o asigna un issue a `Mintlify` para activar una actualización de documentación. El agente utiliza el título, la descripción y el hilo de comentarios del issue como contexto, y luego abre una solicitud de extracción en tu repositorio de documentación. + +Usa el agente en Linear para: + +- **Actualizar la documentación a partir de issues de funcionalidades**: Cuando se lanza una funcionalidad, menciona al agente en el issue para redactar o actualizar la documentación correspondiente. +- **Actuar sobre comentarios de documentación**: Crea issues en Linear para mejoras de documentación y menciona al agente para que realice los cambios. +- **Generar notas de versión**: Menciona al agente en un issue relacionado con un lanzamiento para redactar entradas de changelog basadas en los detalles del issue. +- **Corregir problemas reportados**: Cuando alguien reporta un problema de documentación en Linear, menciona al agente para resolverlo. + +
+ ## Mejores prácticas +
+ +- **Incluye contexto en el issue**: Cuanto más contexto proporciones en un issue, mejor será la solicitud de extracción resultante. +- **Revisa las solicitudes de extracción**: Siempre revisa las solicitudes de extracción que crea el agente antes de fusionarlas. +- **Itera en los comentarios**: Responde en el mismo hilo del issue para refinar el resultado del agente, de forma similar a como lo harías en Slack. diff --git a/es/agent/slack.mdx b/es/agent/slack.mdx index 846e16cb2..8c1482da6 100644 --- a/es/agent/slack.mdx +++ b/es/agent/slack.mdx @@ -12,18 +12,17 @@ keywords: ["Integración con Slack", "Bot de Slack", "Colaboración en equipo", ## Conecta tu espacio de trabajo de Slack -1. Abre el panel del agente en tu dashboard. -2. Haz clic en el botón **Settings**. - - El botón de configuración en modo claro. - El botón de configuración en modo oscuro. - -3. En la sección de integración con Slack, haz clic en **Connect**. -4. Sigue las indicaciones de Slack para agregar la app `mintlify` a tu espacio de trabajo. -5. Sigue las indicaciones de Slack para vincular tu cuenta de Mintlify con tu espacio de trabajo de Slack. -6. Verifica que el agente esté funcionando y responda cuando: - - Le envíes un mensaje directo. - - Lo menciones con `@mintlify` en un canal. +1. Ve a la página de [Agent](https://dashboard.mintlify.com/products/agent) en tu dashboard. +2. En la sección "Agent settings", haz clic en **Install Slack app**. + + La sección de configuración de aplicaciones con los botones de instalación de Slack y Linear. + La sección de configuración de aplicaciones con los botones de instalación de Slack y Linear. + +3. Sigue las indicaciones de Slack para instalar la app `mintlify` en tu espacio de trabajo. +4. Sigue las indicaciones de Slack para vincular tu cuenta de Mintlify con tu espacio de trabajo de Slack. +5. Verifica que el agente esté funcionando y responda cuando: + - Le envíes un mensaje directo al agente. + - Menciones al agente con `@mintlify` en un canal.
## Usar el agente en Slack diff --git a/es/guides/automate-agent.mdx b/es/guides/automate-agent.mdx index f4bf03244..9b212b0e2 100644 --- a/es/guides/automate-agent.mdx +++ b/es/guides/automate-agent.mdx @@ -48,23 +48,10 @@ Este tutorial asume que tu documentación está en un repositorio separado del c La aplicación de Mintlify debe estar instalada en tu repositorio de código para que el agente pueda obtener el contexto de tu código base. Para agregar la aplicación a repositorios nuevos: - 1. Abre el panel del agente en tu Dashboard de Mintlify. - - - El panel del agente en modo claro. - - El panel del agente en modo oscuro. - - 2. Haz clic en el botón **Settings**. - - - El botón de configuración en modo claro. - - El botón de configuración en modo oscuro. - - 3. Haz clic en **Add to New Organization**. Esto te llevará a la página de instalación de la aplicación en GitHub. - 4. Selecciona en la lista los repositorios a los que quieres otorgar acceso. - 5. Guarda tus cambios. + 1. Ve a la página de [Agent](https://dashboard.mintlify.com/products/agent) en tu dashboard. + 1. Haz clic en **Add to New Organization**. Esto te llevará a la página de instalación de la aplicación en GitHub. + 1. Selecciona en la lista los repositorios a los que quieres otorgar acceso. + 1. Guarda tus cambios. ### Obtén tu clave de API de administrador @@ -222,23 +209,10 @@ Este tutorial asume que tu documentación está en un repositorio separado del c La aplicación de Mintlify debe estar instalada en tu repositorio de código para que el agente pueda obtener el contexto de tu código base. Para agregar la aplicación a repositorios nuevos: - 1. Abre el panel del agente en tu Dashboard de Mintlify. - - - El panel del agente en modo claro. - - El panel del agente en modo oscuro. - - 2. Haz clic en el botón **Settings**. - - - El botón de configuración en modo claro. - - El botón de configuración en modo oscuro. - - 3. Haz clic en **Add to New Organization**. Irás a la página de instalación de la aplicación en GitHub. - 4. Selecciona en la lista los repositorios a los que deseas conceder acceso. - 5. Guarda los cambios. + 1. Ve a la página de [Agent](https://dashboard.mintlify.com/products/agent) en tu dashboard. + 1. Haz clic en **Add to New Organization**. Irás a la página de instalación de la aplicación en GitHub. + 1. Selecciona en la lista los repositorios a los que deseas conceder acceso. + 1. Guarda los cambios. ### Obtén tu clave de API de administrador diff --git a/fr/agent/index.mdx b/fr/agent/index.mdx index 7e01c57b0..a4f7e439a 100644 --- a/fr/agent/index.mdx +++ b/fr/agent/index.mdx @@ -24,7 +24,7 @@ Tous les changements passent par des pull requests (demandes de fusion). L'agent Utilisez l’agent pour : -* Rédiger de nouveaux contenus à partir de vos prompts, pull requests (demandes de fusion), fils Slack ou pièces jointes. +* Rédiger de nouveaux contenus à partir de vos prompts, pull requests (demandes de fusion), issues Linear, fils Slack ou pièces jointes. * Mettre à jour la documentation existante pour de nouvelles fonctionnalités ou des évolutions d’API. * Traiter et intégrer des images, des schémas et d’autres fichiers à partir des pièces jointes Slack. * Rechercher et réviser des exemples de code et des références d’API dans l’ensemble de votre documentation. @@ -53,6 +53,9 @@ L’agent ne peut accéder qu’aux dépôts que vous connectez via la GitHub Ap Ajoutez l'agent à votre espace de travail Slack. + + Ajoutez l'agent à votre espace de travail Linear. + Configurez l'agent avec un fichier `AGENTS.md`. diff --git a/fr/agent/linear.mdx b/fr/agent/linear.mdx new file mode 100644 index 000000000..d27eda521 --- /dev/null +++ b/fr/agent/linear.mdx @@ -0,0 +1,40 @@ +--- +title: "Ajouter l'agent à Linear" +description: "Utilisez l'agent dans Linear pour créer des mises à jour de documentation à partir d'issues et de commentaires." +keywords: ["issue tracking", "project management"] +--- + +Connectez votre espace de travail Linear à l'agent pour effectuer des mises à jour de documentation depuis Linear. Lorsque vous mentionnez l'agent Mintlify dans un commentaire Linear ou que vous lui assignez une issue, l'agent récupère le contexte de l'issue et ouvre une pull request (demande de fusion) avec les modifications proposées pour votre documentation. + +
+ ## Connectez votre espace de travail Linear +
+ +1. Accédez à la page [Agent](https://dashboard.mintlify.com/products/agent) de votre Dashboard. +2. Dans la section "Agent settings", cliquez sur **Install Linear app**. + + La section des paramètres d'application avec les boutons d'installation de Slack et Linear. + La section des paramètres d'application avec les boutons d'installation de Slack et Linear. + +3. Suivez les instructions de Linear pour autoriser l'application Mintlify dans votre espace de travail. + +
+ ## Utiliser l'agent dans Linear +
+ +Une fois connecté, mentionnez `@mintlify` dans une issue Linear ou assignez une issue à `Mintlify` pour déclencher une mise à jour de la documentation. L'agent utilise le titre, la description et le fil de commentaires de l'issue comme contexte, puis ouvre une pull request (demande de fusion) dans votre référentiel de documentation. + +Utilisez l'agent dans Linear pour : + +- **Mettre à jour la documentation à partir d'issues de fonctionnalités** : Lorsqu'une fonctionnalité est livrée, mentionnez l'agent dans l'issue pour rédiger ou mettre à jour la documentation correspondante. +- **Agir sur les retours de documentation** : Créez des issues Linear pour les améliorations de documentation et mentionnez l'agent pour effectuer les modifications. +- **Générer des notes de version** : Mentionnez l'agent dans une issue liée à une release pour rédiger des entrées de changelog basées sur les détails de l'issue. +- **Corriger les problèmes signalés** : Lorsque quelqu'un signale un problème de documentation dans Linear, mentionnez l'agent pour le résoudre. + +
+ ## Bonnes pratiques +
+ +- **Incluez du contexte dans l'issue** : Plus vous fournissez de contexte dans une issue, meilleure sera la pull request (demande de fusion) résultante. +- **Relisez les pull requests** : Relisez toujours les pull requests (demandes de fusion) créées par l'agent avant de les fusionner. +- **Itérez dans les commentaires** : Répondez dans le même fil de l'issue pour affiner le résultat de l'agent, comme vous le feriez dans Slack. diff --git a/fr/agent/slack.mdx b/fr/agent/slack.mdx index fff1e7a9d..bc8b75f19 100644 --- a/fr/agent/slack.mdx +++ b/fr/agent/slack.mdx @@ -12,18 +12,17 @@ keywords: ["Intégration Slack", "Bot Slack", "Collaboration d'équipe", "Intég ## Connectez votre espace de travail Slack
-1. Ouvrez le panneau de l'agent dans votre Dashboard. -2. Cliquez sur le bouton **Settings**. - - Le bouton des paramètres en mode clair. - Le bouton des paramètres en mode sombre. - -3. Dans la section d'intégration à Slack, cliquez sur **Connect**. -4. Suivez les instructions Slack pour ajouter l'application `mintlify` à votre espace de travail. -5. Suivez les instructions Slack pour lier votre compte Mintlify à votre espace de travail Slack. -6. Vérifiez que l'agent fonctionne et répond lorsque vous : - - Lui envoyez un message direct. - - Le mentionnez avec `@mintlify` dans un canal. +1. Accédez à la page [Agent](https://dashboard.mintlify.com/products/agent) de votre Dashboard. +2. Dans la section "Agent settings", cliquez sur **Install Slack app**. + + La section des paramètres d'application avec les boutons d'installation de Slack et Linear. + La section des paramètres d'application avec les boutons d'installation de Slack et Linear. + +3. Suivez les instructions Slack pour installer l'application `mintlify` dans 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 : + - Envoyez un message direct à l'agent. + - Mentionnez l'agent avec `@mintlify` dans un canal.
## Utiliser l'agent dans Slack diff --git a/fr/guides/automate-agent.mdx b/fr/guides/automate-agent.mdx index 1db5a1c63..caad99c35 100644 --- a/fr/guides/automate-agent.mdx +++ b/fr/guides/automate-agent.mdx @@ -48,25 +48,12 @@ Ce tutoriel part du principe que votre documentation se trouve dans un référen L'application Mintlify doit être installée sur votre référentiel de code pour que l'agent puisse récupérer le contexte depuis votre base de code. Pour ajouter l'application à de nouveaux référentiels : - 1. Ouvrez le panneau Agent dans votre tableau de bord Mintlify. + 1. Accédez à la page [Agent](https://dashboard.mintlify.com/products/agent) de votre Dashboard. + 1. Cliquez sur **Add to New Organization**. Vous accéderez à la page d'installation de l'application sur GitHub. + 1. Sélectionnez dans la liste les dépôts auxquels vous souhaitez accorder l'accès. + 1. Enregistrez vos modifications. - - Le panneau de l’agent en mode clair. - - Le panneau de l’agent en mode sombre. - - 2. Cliquez sur le bouton **Paramètres**. - - - Le bouton Paramètres en mode clair. - - Le bouton Paramètres en mode sombre. - - 3. Cliquez sur **Add to New Organization**. Vous accéderez à la page d'installation de l'application sur GitHub. - 4. Sélectionnez dans la liste les dépôts auxquels vous souhaitez accorder l’accès. - 5. Enregistrez vos modifications. - - ### Obtenez votre clé API d'administration + ### Obtenez votre clé API d'administration 1. Accédez à la page [Clés API](https://dashboard.mintlify.com/settings/organization/api-keys) depuis votre tableau de bord. 2. Sélectionnez **Créer une clé API administrateur**. @@ -222,23 +209,10 @@ Ce tutoriel part du principe que votre documentation se trouve dans un référen L'application Mintlify doit être installée sur votre référentiel de code pour que l'agent puisse récupérer le contexte depuis votre base de code. Pour ajouter l'application à de nouveaux référentiels : - 1. Ouvrez le panneau Agent dans votre tableau de bord Mintlify. - - - Le panneau de l’agent en mode clair. - - Le panneau de l’agent en mode sombre. - - 2. Cliquez sur le bouton **Paramètres**. - - - Le bouton Paramètres en mode clair. - - Le bouton Paramètres en mode sombre. - - 3. Cliquez sur **Add to New Organization**. Vous accéderez à la page d'installation de l'application sur GitHub. - 4. Sélectionnez, dans la liste, les dépôts auxquels vous souhaitez accorder l’accès. - 5. Enregistrez vos modifications. + 1. Accédez à la page [Agent](https://dashboard.mintlify.com/products/agent) de votre Dashboard. + 1. Cliquez sur **Add to New Organization**. Vous accéderez à la page d'installation de l'application sur GitHub. + 1. Sélectionnez, dans la liste, les dépôts auxquels vous souhaitez accorder l'accès. + 1. Enregistrez vos modifications. ### Obtenez votre clé API d'administration diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index 7f82a3a9d..f644f9654 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -24,7 +24,7 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议 使用智能助手可以： -* 根据你的提示词、拉取请求 (PR；亦称“合并请求”/Merge Request) 、Slack 线程或文件附件撰写新内容。 +* 根据你的提示词、拉取请求 (PR；亦称“合并请求”/Merge Request) 、Linear issue、Slack 线程或文件附件撰写新内容。 * 根据新功能或 API 变更更新现有文档。 * 处理并插入来自 Slack 附件的图片、图表和其他文件。 * 在你的文档中搜索并修改代码示例和 API 参考。 @@ -53,6 +53,9 @@ Agent 只能访问你通过 Mintlify GitHub 应用连接的仓库。你可以在 将 agent 添加到你的 Slack 工作区。 + + 将 agent 添加到你的 Linear 工作区。 + 使用 `AGENTS.md` 文件配置 agent。 diff --git a/zh/agent/linear.mdx b/zh/agent/linear.mdx new file mode 100644 index 000000000..0b5c1a2f1 --- /dev/null +++ b/zh/agent/linear.mdx @@ -0,0 +1,40 @@ +--- +title: "将 agent 添加到 Linear" +description: "在 Linear 中使用 agent，从 issue 和评论中创建文档更新。" +keywords: ["issue tracking", "project management"] +--- + +将你的 Linear 工作区连接到 agent，即可从 Linear 中进行文档更新。当你在 Linear 评论中提及 Mintlify agent 或将 issue 分配给它时，agent 会从该 issue 中获取上下文，并在你的文档仓库中创建一个包含建议更改的拉取请求 (PR；亦称"合并请求"/Merge Request) 。 + +
+ ## 连接你的 Linear 工作区 +
+ +1. 在控制台中进入 [Agent](https://dashboard.mintlify.com/products/agent) 页面。 +2. 在 "Agent settings" 部分，点击 **Install Linear app**。 + + 应用设置区域，包含 Slack 和 Linear 安装按钮。 + 应用设置区域，包含 Slack 和 Linear 安装按钮。 + +3. 按照 Linear 的提示授权 Mintlify 应用访问你的工作区。 + +
+ ## 在 Linear 中使用 agent +
+ +连接完成后，在 Linear issue 中提及 `@mintlify` 或将 issue 分配给 `Mintlify` 即可触发文档更新。agent 会利用 issue 的标题、描述和评论线程作为上下文，然后在你的文档仓库中创建一个拉取请求 (PR；亦称"合并请求"/Merge Request) 。 + +在 Linear 中使用 agent 可以： + +- **根据功能 issue 更新文档**：当某个功能发布时，在 issue 中提及 agent 以起草或更新相关文档。 +- **处理文档反馈**：在 Linear 中创建文档改进 issue，并提及 agent 来执行相应更改。 +- **生成发布说明**：在与发布相关的 issue 中提及 agent，根据 issue 详情起草变更日志条目。 +- **修复报告的问题**：当有人在 Linear 中报告文档问题时，提及 agent 来解决它。 + +
+ ## 最佳实践 +
+ +- **在 issue 中提供充足的上下文**：你在 issue 中提供的上下文越多，生成的拉取请求质量就越高。 +- **审查拉取请求**：在合并之前，始终审查 agent 创建的拉取请求。 +- **在评论中迭代**：在同一 issue 线程中回复以优化 agent 的输出，就像在 Slack 中一样。 diff --git a/zh/agent/slack.mdx b/zh/agent/slack.mdx index 68e527dd2..9d7f8ca5d 100644 --- a/zh/agent/slack.mdx +++ b/zh/agent/slack.mdx @@ -12,18 +12,17 @@ keywords: ["Slack 集成", "Slack 机器人", "团队协作", "agent 集成", " ## 连接你的 Slack 工作区
-1. 在控制台中打开 agent 面板。 -2. 点击 **Settings** 按钮。 - - 浅色模式下的设置按钮。 - 深色模式下的设置按钮。 - -3. 在 Slack 集成区域，点击 **Connect**。 -4. 按照 Slack 的提示将 `mintlify` 应用添加到你的工作区。 -5. 按照 Slack 的提示将你的 Mintlify 账户关联到你的 Slack 工作区。 -6. 测试 agent 是否正常工作，并在你执行以下操作时是否会响应： - - 向它发送一条私信。 - - 在频道中使用 `@mintlify` 提及它。 +1. 在控制台中进入 [Agent](https://dashboard.mintlify.com/products/agent) 页面。 +2. 在 "Agent settings" 部分，点击 **Install Slack app**。 + + 应用设置区域，包含 Slack 和 Linear 安装按钮。 + 应用设置区域，包含 Slack 和 Linear 安装按钮。 + +3. 按照 Slack 的提示将 `mintlify` 应用安装到你的工作区。 +4. 按照 Slack 的提示将你的 Mintlify 账户关联到你的 Slack 工作区。 +5. 测试 agent 是否正常工作，并在你执行以下操作时是否会响应： + - 向 agent 发送一条私信。 + - 在频道中使用 `@mintlify` 提及 agent。
## 在 Slack 中使用智能体 diff --git a/zh/guides/automate-agent.mdx b/zh/guides/automate-agent.mdx index 69fa7825a..7241e95c5 100644 --- a/zh/guides/automate-agent.mdx +++ b/zh/guides/automate-agent.mdx @@ -48,23 +48,10 @@ keywords: ["agent automation", "n8n", "GitHub Actions", "automatic doc updates"] 必须在您的代码存储库中安装 Mintlify 应用,以便 agent 能够从代码库获取上下文信息。要将应用添加到新存储库: - 1. 打开 Mintlify 控制台中的 Agent 面板。 - - - 浅色模式下的 Agent 面板。 - - 深色模式下的 Agent 面板。 - - 2. 点击 **Settings** 按钮。 - - - 浅色模式下的设置按钮。 - - 深色模式下的设置按钮。 - - 3. Click **Add to New Organization**。这会打开 GitHub 上的应用安装页面。 - 4. 从列表中选择你要授予访问权限的仓库。 - 5. 保存更改。 + 1. 在控制台中进入 [Agent](https://dashboard.mintlify.com/products/agent) 页面。 + 1. 点击 **Add to New Organization**。这会打开 GitHub 上的应用安装页面。 + 1. 从列表中选择你要授予访问权限的仓库。 + 1. 保存更改。 ### 获取管理员 API 密钥 @@ -222,23 +209,10 @@ keywords: ["agent automation", "n8n", "GitHub Actions", "automatic doc updates"] 必须在您的代码存储库中安装 Mintlify 应用,以便 agent 能够从代码库获取上下文信息。要将应用添加到新存储库: - 1. 在 Mintlify 控制台中打开 Agent 面板。 - - - 浅色模式下的 Agent 面板。 - - 深色模式下的 Agent 面板。 - - 2. Click the **Settings** button. - - - 浅色模式下的设置按钮。 - - 深色模式下的设置按钮。 - - 3. Click **Add to New Organization**。这会打开 GitHub 上的应用安装页面。 - 4. 从列表中选择要授予访问权限的仓库。 - 5. 保存更改。 + 1. 在控制台中进入 [Agent](https://dashboard.mintlify.com/products/agent) 页面。 + 1. 点击 **Add to New Organization**。这会打开 GitHub 上的应用安装页面。 + 1. 从列表中选择要授予访问权限的仓库。 + 1. 保存更改。 ### 获取管理员 API 密钥