From 437198db6b7972f079e15b63f388a33688c6dd99 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 27 Feb 2026 17:02:56 +0000 Subject: [PATCH] Translate workflow updates to es/fr/zh Generated-By: mintlify-agent --- es/agent/index.mdx | 4 ++ es/agent/use-cases.mdx | 8 +++ es/agent/workflows.mdx | 112 ++++++++++++++++++++++++++--------------- fr/agent/index.mdx | 54 +++++++++++--------- fr/agent/use-cases.mdx | 12 ++++- fr/agent/workflows.mdx | 111 +++++++++++++++++++++++++++++++--------- zh/agent/index.mdx | 4 ++ zh/agent/use-cases.mdx | 8 +++ zh/agent/workflows.mdx | 95 ++++++++++++++++++++++++++++------ 9 files changed, 301 insertions(+), 107 deletions(-) diff --git a/es/agent/index.mdx b/es/agent/index.mdx index cfe979fd8..ac4571a67 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -28,6 +28,7 @@ Usa el agente para: * 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. +* Automatizar el mantenimiento de la documentación con flujos de trabajo. * Responder preguntas sobre tu documentación y temas de redacción técnica. * Atender comentarios de revisión de código para mantener la calidad de la documentación. * Capturar conocimiento de conversaciones en Slack y solicitudes de extracción antes de que se pierda. @@ -64,4 +65,7 @@ Usa el agente para: Obtén mejores resultados con prompts más específicos. + + + Automatiza tareas recurrentes y el mantenimiento de la documentación con flujos de trabajo. \ No newline at end of file diff --git a/es/agent/use-cases.mdx b/es/agent/use-cases.mdx index 04bf03c5c..d5a3994e3 100644 --- a/es/agent/use-cases.mdx +++ b/es/agent/use-cases.mdx @@ -78,6 +78,14 @@ Proporciona al agente los comentarios de tus usuarios para realizar actualizacio Por ejemplo: `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. +
+ ## Automatizar con flujos de trabajo +
+ +Crea flujos de trabajo para automatizar tareas recurrentes y tareas de mantenimiento reactivo como escribir changelogs o actualizar contenido cuando se agregan nuevas funcionalidades a tu producto. + +Consulta [Flujos de trabajo](/es/agent/workflows) para obtener más información. +
## Automatiza con la API
diff --git a/es/agent/workflows.mdx b/es/agent/workflows.mdx index 29c7b8cf9..e99ceb0ed 100644 --- a/es/agent/workflows.mdx +++ b/es/agent/workflows.mdx @@ -2,21 +2,47 @@ title: "Flujos de trabajo" description: "Automatiza el mantenimiento de la documentación con tareas del agente programadas o activadas por eventos." keywords: ["automation", "automate", "cron", "auto-update"] +tag: "Beta" --- -Los flujos de trabajo están en beta. Ponte en contacto con nosotros directamente para habilitarlos. + Los flujos de trabajo están en beta. Actualmente están disponibles en los [planes Enterprise](https://mintlify.com/pricing). + + [Contáctanos](mailto:gtm@mintlify.com) para habilitar flujos de trabajo para tu organización. -Los flujos de trabajo ejecutan el agente automáticamente de forma programada o cuando se realiza un push a un repositorio que especifiques. Cada flujo de trabajo define una instrucción para el agente y un disparador que indica cuándo ejecutarlo. +Los flujos de trabajo ejecutan el agente automáticamente de forma programada o cuando se realiza un push a un repositorio. Cada flujo de trabajo define una instrucción para el agente y un disparador que indica cuándo ejecutarlo. Cuando se ejecuta un flujo de trabajo, el agente clona los repositorios especificados como contexto, sigue la instrucción y abre una solicitud de extracción o hace push directamente de los cambios a tu rama de implementación. -
- ## Crear un archivo de flujo de trabajo +Puedes tener hasta 10 flujos de trabajo activos. Cada flujo de trabajo puede ejecutarse hasta 20 veces al día. Las ejecuciones fallidas no cuentan para este límite. + + +Usa flujos de trabajo que se ejecutan según un horario para automatizar tareas recurrentes como publicar changelogs o verificar problemas de gramática y estilo. + +Usa flujos de trabajo que se ejecutan en eventos push para automatizar tareas de mantenimiento reactivo como actualizar referencias de API o identificar actualizaciones de documentación necesarias para nuevas funcionalidades. + + +
+ ## Crear un flujo de trabajo +
+ +
+ ### Crear un flujo de trabajo en el dashboard +
+ +En la página de [Flujos de trabajo](https://dashboard.mintlify.com/products/workflows) de tu dashboard, haz clic en el botón **New workflow**. + + +La página de configuración de nuevo flujo de trabajo. +La página de configuración de nuevo flujo de trabajo. + + +
+ ### Agregar un archivo de flujo de trabajo a tu repositorio
-Crea archivos `.md` en un directorio `.mintlify/workflows/` en la raíz de tu repositorio de documentación. Cada archivo define un flujo de trabajo. +Crea un archivo `.md` para cada flujo de trabajo en un directorio `.mintlify/workflows/` en la raíz de tu repositorio de documentación. Cada archivo define un flujo de trabajo. Los archivos de flujo de trabajo usan frontmatter YAML para configurar el flujo de trabajo, seguido de un prompt en Markdown para el agente. @@ -41,7 +67,7 @@ Success criteria: Someone who reads the changelog knows the most up to date info
- ### Campos de frontmatter + ## Campos de frontmatter
| Campo | Obligatorio | Descripción | @@ -59,13 +85,13 @@ Debes tener la Aplicación de GitHub de Mintlify instalada en cada repositorio i
- ## Disparadores + ### Disparadores
Cada flujo de trabajo debe definir un único disparador mediante el campo `on`.
- ### Según programación (cron) + #### Según programación (cron)
Ejecuta un flujo de trabajo de forma recurrente usando una expresión cron. Todas las ejecuciones programadas se realizan en UTC. @@ -86,8 +112,8 @@ El campo value es una expresión cron estándar de 5 campos con el formato `minu | `"0 8 * * 1-5"` | Días laborables a las 8:00 AM UTC | -
- ### Al hacer merge +
+ #### En eventos push
Ejecuta un flujo de trabajo cuando se fusiona una solicitud de extracción en un repositorio y branch específicos. @@ -113,8 +139,8 @@ on: ``` -
- ## Repositorios de referencia +
+ ### Repositorios de contexto
Usa `context` para conceder al agente acceso de lectura a repositorios adicionales cuando se ejecuta el flujo de trabajo. Esto es útil cuando tu prompt requiere revisar código o contenido fuera de tu repositorio de documentación. @@ -127,7 +153,7 @@ context:
- ## Combinación automática de cambios + ### Combinación automática de cambios
De forma predeterminada, el agente abre una solicitud de extracción por cada ejecución del flujo de trabajo para que puedas revisar los cambios antes de que se publiquen. Establece `automerge: true` para enviar los cambios directamente a tu rama de implementación sin una solicitud de extracción. @@ -152,65 +178,71 @@ Los prompts eficaces se centran en una sola tarea y buscan un resultado concreto ## Ejemplos de flujos de trabajo
-
- ### Auditoría de estilo +
+ ### Borrador de documentación para nuevas funcionalidades
-Se ejecuta cuando se fusiona una solicitud de extracción de documentación para detectar violaciones de la guía de estilo antes de que se acumulen. Este flujo de trabajo de ejemplo corrige automáticamente las violaciones de la guía de estilo y enumera en el cuerpo de la solicitud de extracción aquellas que requieren criterio humano. + + Si usas sugerencias del agente en tu dashboard, este flujo de trabajo replica ese comportamiento. + + Agrega este flujo de trabajo con cualquier modificación para tu proyecto para redactar documentación automáticamente a medida que agregas nuevas funcionalidades a tu producto. + -```markdown .mintlify/workflows/style-audit.md +Se ejecuta cuando las solicitudes de extracción se fusionan en el repositorio de tu producto para identificar las actualizaciones de documentación necesarias para cualquier nueva funcionalidad o API que se haya introducido. + +```markdown .mintlify/workflows/draft-feature-docs.md --- -name: Style audit +name: Draft docs for new features on: push: - - repo: your-org/your-docs + - repo: your-org/your-product branch: main +context: + - repo: your-org/your-docs automerge: false --- -Review all MDX files changed in the last merged PR against the style guide at `path/to/style-guide`. +Review the diff from the last merged PR in `your-org/your-product`. Identify any new features, APIs, or other changes that require documentation. -Open a pull request to resolve any style violations that can be fixed automatically. For any edits that require judgment or nuance, note them in the PR body with the specific lines, rule violations, and suggested fixes. +For each new addition, draft documentation updates that explain what it does, when to use it, and how to configure it. Include a code example where relevant. -Success criteria: -- All style violations have a proposed resolution. -- No new style violations are introduced. +Success criteria: After reading any new or updated documentation, users understand what the feature is, if it applies to tasks they do, and how to use it. ## Important -- Do not change content meaning. Only correct style violations. -- Skip any files in language subdirectories (`es/`, `fr/`, `zh/`). +- Only document changes that affect end users. Skip internal refactors or dependency updates. +- Match the style and structure of existing docs pages. ``` -
- ### Borrador de documentación para nuevas funcionalidades +
+ ### Auditoría de estilo
-Se ejecuta cuando las solicitudes de extracción se fusionan en el repositorio de tu producto para identificar las actualizaciones de documentación necesarias para cualquier nueva funcionalidad o API que se haya introducido. +Se ejecuta cuando se fusiona una solicitud de extracción de documentación para detectar violaciones de la guía de estilo antes de que se acumulen. Este flujo de trabajo de ejemplo corrige automáticamente las violaciones de la guía de estilo y enumera en el cuerpo de la solicitud de extracción aquellas que requieren criterio humano. -```markdown .mintlify/workflows/draft-feature-docs.md +```markdown .mintlify/workflows/style-audit.md --- -name: Borrador de documentación para nuevas funciones +name: Style audit on: push: - - repo: your-org/your-product + - repo: your-org/your-docs branch: main -context: - - repo: your-org/your-docs automerge: false --- -Revisa el diff del último PR fusionado en `your-org/your-product`. Identifica cualquier nueva función, API u otros cambios que requieran documentación. +Review all MDX files changed in the last merged PR against the style guide at `path/to/style-guide`. -Para cada nueva incorporación, redacta actualizaciones de documentación que expliquen qué hace, cuándo usarla y cómo configurarla. Incluye un ejemplo de código donde sea relevante. +Open a pull request to resolve any style violations that can be fixed automatically. For any edits that require judgment or nuance, note them in the PR body with the specific lines, rule violations, and suggested fixes. -Criterios de éxito: Tras leer la documentación nueva o actualizada, los usuarios comprenden qué es la función, si se aplica a las tareas que realizan y cómo usarla. +Success criteria: +- All style violations have a proposed resolution. +- No new style violations are introduced. -## Importante +## Important -- Documenta solo los cambios que afecten a los usuarios finales. Omite refactorizaciones internas o actualizaciones de dependencias. -- Mantén el estilo y la estructura de las páginas de documentación existentes. +- Do not change content meaning. Only correct style violations. +- Skip any files in language subdirectories (`es/`, `fr/`, `zh/`). ``` diff --git a/fr/agent/index.mdx b/fr/agent/index.mdx index 1611d9c01..5db71784e 100644 --- a/fr/agent/index.mdx +++ b/fr/agent/index.mdx @@ -1,67 +1,71 @@ --- -title: "Qu'est-ce que l'agent ?" +title: "Qu'est-ce que l'agent ?" description: "Automatisez les mises à jour de la documentation avec l'agent. Créez des mises à jour à partir de messages Slack, de pull requests ou d'appels d'API." keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] --- - L'agent est disponible sur les [plans Enterprise](https://mintlify.com/pricing?ref=agent) pour toute personne ayant accès à votre Dashboard. + L'agent est disponible sur les [plans Enterprise](https://mintlify.com/pricing?ref=agent) pour toute personne ayant accès à votre Dashboard. -L'agent est un outil d'IA qui crée des pull requests (demandes de fusion) avec des modifications proposées pour votre documentation, en fonction de vos instructions. Lorsque vous envoyez une requête, l'agent : +L'agent est un outil d'IA qui crée des pull requests (demandes de fusion) avec des modifications proposées pour votre documentation, en fonction de vos instructions. Lorsque vous envoyez une requête, l'agent : -* **Recherche** : analyse votre documentation existante, les dépôts connectés et le contexte pertinent. -* **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. +* **Recherche** : analyse votre documentation existante, les dépôts connectés et le contexte pertinent. +* **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. +Tous les changements passent par des pull requests (demandes de fusion). L'agent ne fait jamais de commit directement sur votre branche principale.
- ## Ce que vous pouvez faire avec l’agent + ## Ce que vous pouvez faire avec l'agent
-Utilisez l’agent pour : +Utilisez l'agent pour : * Rédiger de nouveaux contenus à partir de vos prompts, pull requests (demandes de fusion), 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. +* 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. +* Automatiser la maintenance de la documentation avec des workflows. * Répondre aux questions sur votre documentation et sur des sujets de rédaction technique. * Traiter les retours de revue de code pour maintenir la qualité de la documentation. -* Capitaliser les connaissances issues des conversations Slack et des pull requests (demandes de fusion) avant qu’elles ne soient perdues. +* Capitaliser les connaissances issues des conversations Slack et des pull requests (demandes de fusion) avant qu'elles ne soient perdues. * Naviguer et coordonner efficacement les modifications dans plusieurs fichiers et répertoires.
- ## Où vous pouvez utiliser l’agent + ## Où vous pouvez utiliser l'agent
-* **Dashboard** : Depuis n’importe quelle page de votre Dashboard, utilisez le raccourci clavier ⌘+I (macOS) ou Ctrl+I (Windows/Linux) pour ouvrir le panneau de l’agent. Vous pouvez aussi cliquer sur **Ask agent** sur la page [Overview](https://dashboard.mintlify.com/). +* **Dashboard** : Depuis n'importe quelle page de votre Dashboard, utilisez le raccourci clavier ⌘+I (macOS) ou Ctrl+I (Windows/Linux) pour ouvrir le panneau de l'agent. Vous pouvez aussi cliquer sur **Ask agent** sur la page [Overview](https://dashboard.mintlify.com/). - Le panneau de l’agent ouvert dans le Dashboard. + Le panneau de l'agent ouvert dans le Dashboard. - Le panneau de l’agent ouvert dans le Dashboard. + Le panneau de l'agent ouvert dans le Dashboard. -* **Slack** : Ajoutez l’agent à votre espace de travail Slack et mentionnez `@mintlify` dans n’importe quel canal. Vous pouvez joindre des fichiers et des images directement à vos messages pour que l’agent les traite. -* **API** : Intégrez l’agent dans des applications personnalisées à l’aide des [points de terminaison de l’agent](/fr/api/agent/create-agent-job). +* **Slack** : Ajoutez l'agent à votre espace de travail Slack et mentionnez `@mintlify` dans n'importe quel canal. Vous pouvez joindre des fichiers et des images directement à vos messages pour que l'agent les traite. +* **API** : Intégrez l'agent dans des applications personnalisées à l'aide des [points de terminaison de l'agent](/fr/api/agent/create-agent-job).
## Prochaines étapes
- Commencez à utiliser l'agent dans votre Dashboard. + Commencez à utiliser l'agent dans votre Dashboard. - Ajoutez l'agent à votre espace de travail Slack. + Ajoutez l'agent à votre espace de travail Slack. - Configurez l'agent avec un fichier `AGENTS.md`. + Configurez l'agent avec un fichier `AGENTS.md`. Obtenez de meilleurs résultats grâce à des prompts ciblés. - \ No newline at end of file + + + Automatisez les tâches récurrentes et la maintenance de la documentation avec des workflows. + diff --git a/fr/agent/use-cases.mdx b/fr/agent/use-cases.mdx index a1d150bf1..7f347ba4f 100644 --- a/fr/agent/use-cases.mdx +++ b/fr/agent/use-cases.mdx @@ -76,10 +76,18 @@ Par exemple : `@mintlify Review the API rate limiting section. We changed limit Soumettez à l’agent les retours de vos utilisateurs pour apporter des mises à jour ciblées à votre documentation. -Par exemple : `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. +Par exemple : `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. + +
+ ## Automatiser avec des workflows +
+ +Créez des workflows pour automatiser les tâches récurrentes et les tâches de maintenance réactive comme la rédaction de changelogs ou la mise à jour du contenu lorsque de nouvelles fonctionnalités sont ajoutées à votre produit. + +Consultez [Workflows](/fr/agent/workflows) pour plus d'informations.
- ## Automatiser avec l'API + ## Automatiser avec l'API
Intégrez l'agent à vos outils d'automatisation existants pour mettre automatiquement à jour la documentation lorsque le code change, déclencher des revues de contenu ou synchroniser les mises à jour de la documentation sur plusieurs dépôts. diff --git a/fr/agent/workflows.mdx b/fr/agent/workflows.mdx index d96d7ba5b..0d6dfad56 100644 --- a/fr/agent/workflows.mdx +++ b/fr/agent/workflows.mdx @@ -1,22 +1,48 @@ --- title: "Workflows" -description: "Automatisez la maintenance de votre documentation avec des tâches d’agent planifiées ou déclenchées par des événements." +description: "Automatisez la maintenance de votre documentation avec des tâches d'agent planifiées ou déclenchées par des événements." keywords: ["automation", "automate", "cron", "auto-update"] +tag: "Beta" --- -Les workflows sont en bêta. Contactez-nous directement pour les activer. + Les workflows sont en bêta. Ils sont actuellement disponibles sur les [plans Enterprise](https://mintlify.com/pricing). + + [Contactez-nous](mailto:gtm@mintlify.com) pour activer les workflows pour votre organisation. -Les workflows exécutent l’agent automatiquement selon un calendrier défini ou lorsqu’un push est effectué sur un référentiel que vous spécifiez. Chaque workflow définit un prompt pour l’agent et un déclencheur indiquant quand l’exécuter. +Les workflows exécutent l'agent automatiquement selon un calendrier défini ou lors d'un push vers un référentiel. Chaque workflow définit un prompt pour l'agent et un déclencheur indiquant quand l'exécuter. + +Lorsqu'un workflow s'exécute, l'agent clone tous les référentiels spécifiés comme contexte, suit le prompt, puis soit ouvre une pull request (demande de fusion), soit pousse directement les modifications vers votre branche de déploiement. + +Vous pouvez avoir jusqu'à 10 workflows actifs. Chaque workflow peut s'exécuter jusqu'à 20 fois par jour. Les exécutions qui échouent ne comptent pas dans cette limite. -Lorsqu’un workflow s’exécute, l’agent clone tous les référentiels spécifiés comme contexte, suit le prompt, puis soit ouvre une pull request (demande de fusion), soit pousse directement les modifications vers votre branche de déploiement. + +Utilisez les workflows qui s'exécutent selon un calendrier pour automatiser les tâches récurrentes comme la publication de changelogs ou la vérification des problèmes de grammaire et de style. + +Utilisez les workflows qui s'exécutent sur des événements push pour automatiser les tâches de maintenance réactive comme la mise à jour des références d'API ou l'identification des mises à jour de documentation nécessaires pour les nouvelles fonctionnalités. + + +
+ ## Créer un workflow +
+ +
+ ### Créer un workflow dans le dashboard +
+ +Sur la page [Workflows](https://dashboard.mintlify.com/products/workflows) de votre dashboard, cliquez sur le bouton **New workflow**. + + +La page de configuration du nouveau workflow. +La page de configuration du nouveau workflow. + -
- ## Créer un fichier de workflow +
+ ### Ajouter un fichier de workflow à votre référentiel
-Créez des fichiers `.md` dans un répertoire `.mintlify/workflows/` situé à la racine de votre référentiel de documentation. Chaque fichier correspond à un workflow. +Créez un fichier `.md` pour chaque workflow dans un répertoire `.mintlify/workflows/` situé à la racine de votre référentiel de documentation. Chaque fichier correspond à un workflow. Les fichiers de workflow utilisent le frontmatter YAML pour configurer le workflow, suivi d'un prompt en Markdown pour l'agent. @@ -41,7 +67,7 @@ Success criteria: Someone who reads the changelog knows the most up to date info
- ### Champs de frontmatter + ## Champs de frontmatter
| Champ | Obligatoire | Description | @@ -59,13 +85,13 @@ Vous devez avoir installé la GitHub App Mintlify sur chaque référentiel répe
- ## Déclencheurs + ### Déclencheurs
Chaque flux de travail doit définir un seul déclencheur en utilisant le champ `on`.
- ### Selon une planification (cron) + #### Selon une planification (cron)
Exécutez un workflow à intervalles réguliers à l'aide d'une expression cron. Toutes les planifications s'exécutent en UTC. @@ -86,11 +112,11 @@ La valeur est une expression cron standard à 5 champs au format `minute hour da | `"0 8 * * 1-5"` | Du lundi au vendredi à 8 h 00 UTC | -
- ### Lors de la fusion +
+ #### Lors d'événements push
-Exécutez un workflow lorsqu'une pull request (demande de fusion) est fusionnée sur un référentiel et une branche spécifiques. +Exécutez un workflow lorsqu'une pull request (demande de fusion) est fusionnée sur un référentiel et une branche spécifiques. ```yaml on: @@ -113,8 +139,8 @@ on: ``` -
- ## Référentiels de référence +
+ ### Référentiels de contexte
Utilisez `context` pour accorder à l’agent un accès en lecture à des référentiels supplémentaires lors de l’exécution du workflow. Cela est utile lorsque votre prompt doit examiner du code ou du contenu en dehors de votre référentiel de documentation. @@ -127,7 +153,7 @@ context:
- ## Fusion automatique des modifications + ### Fusion automatique des modifications
Par défaut, l'agent ouvre une pull request (demande de fusion) pour chaque exécution de workflow afin que vous puissiez examiner les modifications avant leur mise en production. Activez `automerge: true` pour pousser les modifications directement vers votre branche de déploiement sans pull request. @@ -152,11 +178,48 @@ Des prompts efficaces se concentrent sur une seule tâche et visent un résultat ## Exemples de workflows
+
+ ### Brouillon de documentation pour les nouvelles fonctionnalités +
+ + + Si vous utilisez les suggestions de l'agent dans votre dashboard, ce workflow reproduit ce comportement. + + Ajoutez ce workflow avec les modifications adaptées à votre projet pour rédiger automatiquement la documentation au fur et à mesure que vous ajoutez de nouvelles fonctionnalités à votre produit. + + +S'exécute lorsque des pull requests (demandes de fusion) sont fusionnées dans votre référentiel produit afin d'identifier les mises à jour de la documentation nécessaires pour toute nouvelle fonctionnalité ou API introduite. + +```markdown .mintlify/workflows/draft-feature-docs.md +--- +name: Draft docs for new features +on: + push: + - repo: your-org/your-product + branch: main +context: + - repo: your-org/your-docs +automerge: false +--- + +Review the diff from the last merged PR in `your-org/your-product`. Identify any new features, APIs, or other changes that require documentation. + +For each new addition, draft documentation updates that explain what it does, when to use it, and how to configure it. Include a code example where relevant. + +Success criteria: After reading any new or updated documentation, users understand what the feature is, if it applies to tasks they do, and how to use it. + +## Important + +- Only document changes that affect end users. Skip internal refactors or dependency updates. +- Match the style and structure of existing docs pages. +``` + +
### Audit de style
-S’exécute lorsqu’une pull request (demande de fusion) de documentation est fusionnée, afin de détecter les écarts par rapport au guide de style avant qu’ils ne s’accumulent. Cet exemple de flux de travail corrige automatiquement ces écarts et répertorie dans le corps de la pull request toutes les violations qui nécessitent un jugement humain. +S'exécute lorsqu'une pull request (demande de fusion) de documentation est fusionnée, afin de détecter les écarts par rapport au guide de style avant qu'ils ne s'accumulent. Cet exemple de flux de travail corrige automatiquement ces écarts et répertorie dans le corps de la pull request toutes les violations qui nécessitent un jugement humain. ```markdown .mintlify/workflows/style-audit.md --- @@ -168,18 +231,18 @@ on: automerge: false --- -Examinez tous les fichiers MDX modifiés dans le dernier PR fusionné par rapport au guide de style à `path/to/style-guide`. +Review all MDX files changed in the last merged PR against the style guide at `path/to/style-guide`. -Ouvrez une pull request pour résoudre les violations de style pouvant être corrigées automatiquement. Pour toute modification nécessitant un jugement ou de la nuance, notez-les dans le corps de la PR avec les lignes spécifiques, les violations de règles et les corrections suggérées. +Open a pull request to resolve any style violations that can be fixed automatically. For any edits that require judgment or nuance, note them in the PR body with the specific lines, rule violations, and suggested fixes. -Critères de succès : -- Toutes les violations de style ont une résolution proposée. -- Aucune nouvelle violation de style n'est introduite. +Success criteria: +- All style violations have a proposed resolution. +- No new style violations are introduced. ## Important -- Ne modifiez pas le sens du contenu. Corrigez uniquement les violations de style. -- Ignorez les fichiers dans les sous-répertoires de langue (`es/`, `fr/`, `zh/`). +- Do not change content meaning. Only correct style violations. +- Skip any files in language subdirectories (`es/`, `fr/`, `zh/`). ``` diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index 930fe11ec..e2411fe62 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -28,6 +28,7 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议 * 根据新功能或 API 变更更新现有文档。 * 处理并插入来自 Slack 附件的图片、图表和其他文件。 * 在你的文档中搜索并修改代码示例和 API 参考。 +* 通过工作流自动化文档维护。 * 回答与你的文档和技术写作相关的问题。 * 处理代码审查反馈并维护文档质量。 * 在知识从 Slack 对话和拉取请求中流失之前，将其记录下来。 @@ -64,4 +65,7 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议 使用更聚焦的提示词以获得更好的效果。 + + + 通过工作流自动化重复任务和文档维护。 \ No newline at end of file diff --git a/zh/agent/use-cases.mdx b/zh/agent/use-cases.mdx index 5150acb66..1badede08 100644 --- a/zh/agent/use-cases.mdx +++ b/zh/agent/use-cases.mdx @@ -78,6 +78,14 @@ agent 可以协助完成多种文档相关任务。以下示例展示了几种 例如：`@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. +
+ ## 使用工作流自动化 +
+ +创建工作流来自动化重复任务和响应式维护任务，例如编写更新日志或在产品添加新功能时更新内容。 + +有关更多信息，请参阅[工作流](/zh/agent/workflows)。 +
## 使用 API 实现自动化
diff --git a/zh/agent/workflows.mdx b/zh/agent/workflows.mdx index 575b56f07..c4bbf190b 100644 --- a/zh/agent/workflows.mdx +++ b/zh/agent/workflows.mdx @@ -2,21 +2,47 @@ title: "工作流" description: "通过定时或事件触发的 agent 任务自动维护文档。" keywords: ["automation", "automate", "cron", "auto-update"] +tag: "Beta" --- -工作流目前处于测试阶段。如需启用，请直接联系我们。 + 工作流目前处于测试阶段。目前仅在 [Enterprise 方案](https://mintlify.com/pricing)中可用。 + + [联系我们](mailto:gtm@mintlify.com)为你的组织启用工作流。 -工作流会在预设的计划下，或在你指定的存储库发生 push 时自动运行 agent。每个工作流都会为 agent 定义一个提示词，以及一个触发执行的条件。 +工作流会在预设的计划下，或在存储库发生 push 时自动运行 agent。每个工作流都会为 agent 定义一个提示词，以及一个触发执行的条件。 + +当工作流运行时，agent 会将指定的存储库克隆为上下文，遵循提示词，并执行以下两种操作之一：要么创建一个拉取请求（PR；亦称"合并请求"/Merge Request），要么将更改直接推送到你的部署用分支。 + +你最多可以拥有 10 个活跃的工作流。每个工作流每天最多可以运行 20 次。失败的运行不计入此限制。 -当工作流运行时，agent 会将指定的存储库克隆为上下文，遵循提示词，并执行以下两种操作之一：要么创建一个拉取请求（PR；亦称“合并请求”/Merge Request），要么将更改直接推送到你的部署用分支。 + +使用按计划运行的工作流来自动化重复任务，例如发布更新日志或检查语法和风格问题。 + +使用在 push 事件时运行的工作流来自动化响应式维护任务，例如更新 API 参考或识别新功能所需的文档更新。 + + +
+ ## 创建工作流 +
+ +
+ ### 在控制台中创建工作流 +
+ +在控制台的[工作流](https://dashboard.mintlify.com/products/workflows)页面，点击 **New workflow** 按钮。 + + +新建工作流设置页面。 +新建工作流设置页面。 + -
- ## 创建工作流文件 +
+ ### 向存储库添加工作流文件
-在文档存储库根目录的 `.mintlify/workflows/` 目录中创建 `.md` 文件。每个文件定义一个工作流。 +在文档存储库根目录的 `.mintlify/workflows/` 目录中为每个工作流创建一个 `.md` 文件。每个文件定义一个工作流。 工作流文件使用 YAML frontmatter 来配置工作流，后面跟一段提供给智能助手的 Markdown 提示词。 @@ -41,7 +67,7 @@ Success criteria: Someone who reads the changelog knows the most up to date info
- ### frontmatter 字段 + ## frontmatter 字段
| 字段 | 必填 | 说明 | @@ -59,13 +85,13 @@ Success criteria: Someone who reads the changelog knows the most up to date info
- ## 触发器 + ### 触发器
每个工作流必须在 `on` 字段中只定义一个触发器。
- ### 按计划（cron） + #### 按计划（cron）
使用 cron 表达式按固定计划运行工作流。所有计划均使用 UTC 时间运行。 @@ -86,11 +112,11 @@ on: | `"0 8 * * 1-5"` | 每个工作日 8:00（UTC） | -
- ### 在合并时 +
+ #### 在 push 事件时
-当拉取请求（PR；亦称“合并请求”/Merge Request）被合并到指定存储库的特定 branch 时运行工作流。 +当拉取请求（PR；亦称"合并请求"/Merge Request）被合并到指定存储库的特定 branch 时运行工作流。 ```yaml on: @@ -113,8 +139,8 @@ on: ``` -
- ## 参考存储库 +
+ ### 上下文存储库
使用 `context` 在工作流运行时为代理程序提供对其他存储库的只读访问权限。当你的提示词需要查看文档存储库之外的代码或内容时，这会很有用。 @@ -127,7 +153,7 @@ context:
- ## 自动合并更改 + ### 自动合并更改
默认情况下，智能代理会在每次工作流运行时创建一个拉取请求（PR），以便你在更改上线之前进行审查。将 `automerge` 设置为 `true`，即可在不创建拉取请求的情况下，直接将更改推送到你的部署用分支。 @@ -152,11 +178,48 @@ automerge: true ## 工作流程示例
+
+ ### 新功能文档草稿 +
+ + + 如果你在控制台中使用 agent 建议功能，此工作流会复制该行为。 + + 添加此工作流并根据你的项目进行修改，以便在向产品添加新功能时自动起草文档。 + + +当拉取请求（PR；亦称"合并请求"/Merge Request）合并到你的产品存储库时运行，用于识别因引入任何新功能或 API 而需要进行的文档更新。 + +```markdown .mintlify/workflows/draft-feature-docs.md +--- +name: Draft docs for new features +on: + push: + - repo: your-org/your-product + branch: main +context: + - repo: your-org/your-docs +automerge: false +--- + +Review the diff from the last merged PR in `your-org/your-product`. Identify any new features, APIs, or other changes that require documentation. + +For each new addition, draft documentation updates that explain what it does, when to use it, and how to configure it. Include a code example where relevant. + +Success criteria: After reading any new or updated documentation, users understand what the feature is, if it applies to tasks they do, and how to use it. + +## Important + +- Only document changes that affect end users. Skip internal refactors or dependency updates. +- Match the style and structure of existing docs pages. +``` + +
### 样式审查
-在文档拉取请求（PR；亦称“合并请求”/Merge Request）合并时运行，用于在问题累积之前发现违反样式指南的情况。此示例工作流会自动修复样式指南违规，并在 PR 正文中列出所有仍需人工判断的违规项。 +在文档拉取请求（PR；亦称"合并请求"/Merge Request）合并时运行，用于在问题累积之前发现违反样式指南的情况。此示例工作流会自动修复样式指南违规，并在 PR 正文中列出所有仍需人工判断的违规项。 ```markdown .mintlify/workflows/style-audit.md ---