diff --git a/es.json b/es.json index ff0390a74..722312080 100644 --- a/es.json +++ b/es.json @@ -91,6 +91,15 @@ "es/agent/workflows" ] }, + { + "group": "Automatizaciones", + "pages": [ + "es/automations/index", + "es/automations/reference", + "es/automations/manage", + "es/automations/create" + ] + }, { "group": "Componentes", "pages": [ @@ -277,7 +286,7 @@ "pages": [ "es/guides/assistant-embed", "es/guides/configure-automerge", - "es/guides/use-workflows", + "es/guides/use-automations", "es/guides/claude-code", "es/guides/cursor", "es/guides/geo", diff --git a/es/agent/index.mdx b/es/agent/index.mdx index 8482c876f..3f9c2cc5f 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -26,7 +26,7 @@ Usa el agente para: * Buscar y revisar ejemplos de código y referencias de API en toda tu documentación. * Hacer referencia al código fuente de cualquier repositorio que tenga instalada la aplicación de GitHub de Mintlify. * Obtener contexto en vivo desde aplicaciones conectadas como Slack, Notion, Linear y Jira. -* Automatizar el mantenimiento de la documentación mediante flujos de trabajo. +* Automatizar el mantenimiento de la documentación con automatizaciones. * 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. @@ -82,6 +82,6 @@ Luego añade el servidor MCP de Mintlify para acceder al dashboard y a otras her Obtén mejores resultados con prompts más específicos. - - Automatiza tareas recurrentes y el mantenimiento de la documentación mediante flujos de trabajo. + + Automatiza tareas recurrentes y el mantenimiento de la documentación con automatizaciones. \ No newline at end of file diff --git a/es/agent/use-cases.mdx b/es/agent/use-cases.mdx index dd950e037..fbd9449fc 100644 --- a/es/agent/use-cases.mdx +++ b/es/agent/use-cases.mdx @@ -1,7 +1,7 @@ --- title: "Casos de uso" description: "Explora ejemplos reales de uso del agente de Mintlify para automatizar actualizaciones, capturar conocimiento y mantener documentación precisa." -keywords: ["agent workflows", "documentation workflows", "automation examples"] +keywords: ["agent automations", "documentation automations", "automation examples"] --- El agente ayuda con muchas tareas diferentes de documentación. Estos ejemplos muestran algunas de las formas en que puedes integrar el agente en tu proceso de documentación. Prueba un enfoque que encaje con la forma en que tu equipo trabaja actualmente y ajústalo a tus necesidades específicas. @@ -78,13 +78,13 @@ 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?`. -
- ## Automatiza con flujos de trabajo +
+ ## Automatiza con automatizaciones
-Crea flujos de trabajo para automatizar tareas recurrentes y tareas de mantenimiento reactivo, como redactar cambios o actualizar contenido cuando agregas nuevas funcionalidades a tu producto. +Crea automatizaciones para automatizar tareas recurrentes y tareas de mantenimiento reactivo, como redactar cambios o actualizar contenido cuando agregas nuevas funcionalidades a tu producto. -Consulta [Resumen de workflows](/es/workflows/index) para obtener más información. +Consulta [Vista general de automatizaciones](/es/automations/index) para obtener más información.
## Automatiza con la API diff --git a/es/ai-native.mdx b/es/ai-native.mdx index 58874d0b1..81f14614f 100644 --- a/es/ai-native.mdx +++ b/es/ai-native.mdx @@ -23,7 +23,7 @@ Además de leer páginas individuales, los usuarios pueden chatear con el [assis El [agente](/es/agent) te ayuda a redactar y mantener la documentación. Crea solicitudes de extracción con cambios propuestos basados en tus indicaciones, solicitudes de extracción y hilos de Slack. Añade el agente a tu espacio de trabajo de Slack para que cualquiera de tu equipo pueda ayudar a mantener la documentación conversando con él. O integra el agente en aplicaciones personalizadas a través de la [API](/es/api/agent/v2/create-agent-job). -Crea [flujos de trabajo](/automations/index) para ejecutar el agente según una programación o cuando se haga un push a un repositorio. Cada flujo de trabajo define una indicación para el agente y un desencadenador que indica cuándo debe ejecutarse. +Crea [automatizaciones](/es/automations/index) para ejecutar el agente según una programación o cuando se haga un push a un repositorio. Cada automatización define una indicación para el agente y un desencadenador que indica cuándo debe ejecutarse. Configura herramientas populares como [Cursor](/es/guides/cursor), [Claude Code](/es/guides/claude-code) y [Windsurf](/es/guides/windsurf) para que tomen como referencia el esquema de Mintlify, tu guía de estilo y las mejores prácticas. @@ -60,7 +60,7 @@ Selecciona cualquiera de las siguientes tarjetas para obtener más información. Configura el assistant para buscar en sitios externos o derivar a las personas a tu equipo de soporte si no puede responder sus preguntas. - + Recibe actualizaciones de la documentación automáticamente en un horario definido o cuando se produzca un evento de push. diff --git a/es/assistant/index.mdx b/es/assistant/index.mdx index 88af4bed8..27feae26d 100644 --- a/es/assistant/index.mdx +++ b/es/assistant/index.mdx @@ -6,7 +6,7 @@ boost: 3 --- - El assistant está activado por defecto. Las organizaciones Hobby reciben 5,000 créditos de prueba compartidos entre el assistant, los agentes y los workflows. [Compra el paquete de créditos](/es/credits#credit-bundle) para continuar después de la prueba. + El assistant está activado por defecto. Las organizaciones Hobby reciben 5,000 créditos de prueba compartidos entre el assistant, los agentes y las automatizaciones. [Compra el paquete de créditos](/es/credits#credit-bundle) para continuar después de la prueba.
diff --git a/es/automations/create.mdx b/es/automations/create.mdx new file mode 100644 index 000000000..c0c3ddb72 --- /dev/null +++ b/es/automations/create.mdx @@ -0,0 +1,56 @@ +--- +title: "Crear una automatización personalizada" +description: "Crea una automatización personalizada de Mintlify con un activador programado o por push, repositorios de contexto y un prompt para el agente que automatice tareas recurrentes de documentación." +keywords: ["automatización", "automatizar", "cron", "agente", "automatización personalizada"] +--- + +import GitlabAutomationSetup from '/snippets/es/gitlab-automation-setup.mdx'; + +
+## Requisitos previos +
+ +- Un proyecto de Mintlify conectado a un repositorio de GitHub o GitLab +- Para GitHub: la [aplicación de GitHub de Mintlify](/es/deploy/github) instalada en cada repositorio que planees usar en la automatización +- Para GitLab: una cuenta de GitLab conectada (consulta [Configuración de GitLab](#gitlab-setup) más abajo) + +
+## Crear una automatización personalizada +
+ + + El agente se ejecuta en un sandbox aislado con acceso restringido a internet. No puede instalar paquetes o herramientas adicionales en tiempo de ejecución. Los prompts que hagan referencia a herramientas no disponibles pueden producir resultados inesperados o fallar. + + +1. Abre la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. +2. Haz clic en **Create a custom automation**. +3. Configura el nombre de la automatización, el activador, las instrucciones, los repositorios de contexto, las integraciones y el modo de actualización. +4. Haz clic en **Create automation**. + +
+## Escribir instrucciones eficaces +
+ +Las instrucciones eficaces para una automatización se centran en una sola tarea y definen un resultado claro y verificable. Las automatizaciones presentan cierta variabilidad porque los agentes no son deterministas, pero las instrucciones bien formuladas producen resultados más consistentes. + +- **Describe el resultado.** Indícale al agente cómo debe verse una ejecución exitosa. +- **Escribe un procedimiento.** Dale al agente una guía paso a paso a seguir. +- **Mantén un alcance acotado.** Divide las tareas complejas en varias automatizaciones en lugar de combinarlas en un solo prompt. + +Para ver más ejemplos y patrones, consulta [Usar automatizaciones](/es/guides/use-automations). + + + Revisa la salida de tus automatizaciones personalizadas para confirmar que funcionan como esperabas. Actualiza tus instrucciones para mejorar los resultados. + + + + +
+## Eliminar una automatización personalizada +
+ +Eliminar una automatización es permanente y elimina su configuración y el historial de ejecuciones. + +1. Ve a la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. +2. Haz clic en el botón de configuración junto a una automatización. +3. Haz clic en **Delete**. diff --git a/es/automations/index.mdx b/es/automations/index.mdx new file mode 100644 index 000000000..a8b799189 --- /dev/null +++ b/es/automations/index.mdx @@ -0,0 +1,56 @@ +--- +title: "Vista general de automatizaciones" +sidebarTitle: "Vista general" +description: "Automatiza el mantenimiento del contenido con las automatizaciones de Mintlify. Ejecuta el agente según una programación o en respuesta a pushes en repositorios de GitHub y GitLab." +keywords: ["automatización", "automatizar", "cron", "agente", "automatizaciones"] +boost: 5 +--- + +Las automatizaciones ejecutan el agente de forma automática según una programación o en respuesta a cambios en un repositorio. Cada automatización define un prompt para el agente y un activador que indica cuándo ejecutarla. Las automatizaciones son compatibles con repositorios de GitHub y GitLab. + +Cuando se ejecuta una automatización, el agente lee el contenido de tu proyecto y los repositorios conectados, y luego sigue el prompt para realizar las actualizaciones. + + +Usa automatizaciones que se ejecutan según una programación para tareas recurrentes, como publicar registros de cambios o auditar metadatos de SEO. + +Usa automatizaciones que se activan ante cambios de contenido o de código para tareas de mantenimiento reactivas, como traducciones o actualizar el contenido cuando cambia el código fuente. + + +
+## Tipos de activadores +
+ +Las automatizaciones admiten tres tipos de activadores. + +- **Actualización de contenido**: se ejecuta cuando se hacen pushes con cambios de contenido al repositorio de tu proyecto de Mintlify, incluidas las fusiones de pull requests y los pushes directos. +- **Cambio de código**: se ejecuta cuando se fusiona una pull request en un repositorio de código fuente conectado. +- **Programación personalizada**: se ejecuta de forma recurrente. Las automatizaciones se ponen en cola dentro de los 10 minutos siguientes a la hora programada. + +Cada automatización tiene exactamente un activador. No puedes combinar tipos de activadores en una sola automatización. + +
+## Límites de uso +
+ +Las ejecuciones de automatizaciones cuentan para el uso de tus créditos. Consulta tu uso de créditos, configura los excedentes y gestiona tu paquete de créditos en la página [Uso](https://app.mintlify.com/settings/organization/usage) de tu dashboard. + +Cada automatización puede ejecutarse hasta 500 veces al día. Las ejecuciones que fallan no cuentan para este límite. + +
+## Próximos pasos +
+ + + + Referencia de todas las automatizaciones predefinidas: activadores, modos de actualización y configuración requerida. + + + Activa automatizaciones predefinidas y configura activadores, modo de actualización y contexto. + + + Crea una automatización con tu propio activador, instrucciones y repositorios de contexto. + + + Elige el activador adecuado, escribe instrucciones eficaces y revisa los resultados. + + diff --git a/es/automations/manage.mdx b/es/automations/manage.mdx new file mode 100644 index 000000000..c0a8ff9ae --- /dev/null +++ b/es/automations/manage.mdx @@ -0,0 +1,148 @@ +--- +title: "Gestionar automatizaciones" +description: "Activa, desactiva, ejecuta y elimina automatizaciones desde tu dashboard. Configura activadores de GitHub o GitLab, programaciones, repositorios de contexto y automerge." +keywords: ["cron", "push", "automerge", "contexto", "instrucciones de automatización", "activador", "desactivar automatización", "activar automatización"] +--- + +import GitlabAutomationSetup from '/snippets/es/gitlab-automation-setup.mdx'; + +
+## Requisitos previos +
+ +- Un proyecto de Mintlify conectado a un repositorio de GitHub o GitLab +- Para GitHub: la [aplicación de GitHub de Mintlify](/es/deploy/github) instalada en cada repositorio que planees usar en la automatización +- Para GitLab: una cuenta de GitLab conectada (consulta [Configuración de GitLab](#gitlab-setup) más abajo) + + + También puedes crear, listar y eliminar automatizaciones desde la terminal con [`mint automation`](/es/cli/commands#mint-automation). La CLI es útil para scripts y CI; el dashboard es la forma más sencilla de configurar y supervisar las ejecuciones de automatizaciones. + + +
+## Activar una automatización +
+ +1. Abre la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. +2. Haz clic en el interruptor junto a una automatización para activarla. + + El dashboard de automatizaciones. + El dashboard de automatizaciones. + + + Si la automatización puede ejecutarse con la configuración predeterminada, se activa de inmediato. De lo contrario, se abre el panel de configuración para que completes los ajustes obligatorios. + + Las opciones de configuración de una automatización. + Las opciones de configuración de una automatización. + +3. Si se abre el panel de configuración, completa los campos obligatorios. +4. Haz clic en **Turn on automation**. + +Para cambiar la configuración de una automatización activa, haz clic en el botón de configuración junto a ella. Usa el interruptor en el encabezado del modal para activarla o desactivarla sin salir de la vista de configuración. + +
+## Configuraciones +
+ +
+### Activador +
+ +Cada automatización tiene un activador predeterminado que controla cuándo se ejecuta. Para cambiar el activador, selecciona otra opción en el panel de configuración. + +- **Actualización de contenido**: se ejecuta cada vez que envías contenido al repositorio de tu proyecto, incluidas las fusiones de pull requests y los pushes directos. +- **Cambio de código**: se ejecuta cuando se fusiona una pull request en un repositorio de código fuente conectado. Debes especificar al menos un repositorio de origen. +- **Programación personalizada**: se ejecuta de forma recurrente según la programación que definas. Las automatizaciones se ponen en cola dentro de los 10 minutos siguientes a la hora programada. + +
+### Modo de actualización +
+ +Cada automatización tiene un modo predeterminado para realizar actualizaciones. Puede fusionar los cambios directamente en tu repositorio de contenido o abrir una pull request para revisión. + +Para requerir una revisión antes de que la automatización actualice tu contenido, selecciona **Require review** en el panel de configuración. + + + Para repositorios de GitHub, las actualizaciones automáticas requieren que la aplicación de GitHub de Mintlify tenga permisos de bypass en todos los rulesets que apunten a tu rama de implementación, incluidos los rulesets a nivel de organización y de repositorio. Consulta [Configurar automerge](/es/guides/configure-automerge) para ver las instrucciones de configuración. + + Para repositorios de GitLab, el automerge utiliza la conexión OAuth de GitLab y requiere al menos el rol Maintainer en cada proyecto. + + +
+### Repositorios de contexto +
+ +Para automatizaciones personalizadas y algunas automatizaciones predefinidas, puedes añadir repositorios de contexto: repositorios de código fuente adicionales que el agente lee cuando se ejecuta la automatización. Esto es útil cuando el prompt de tu automatización hace referencia a código, APIs u otro contenido que vive fuera del repositorio de tu proyecto. + +Puedes añadir hasta 10 repositorios de contexto por automatización. Para cada repositorio de GitHub, instala la aplicación de GitHub de Mintlify. Añade repositorios en la página de [configuración de la aplicación de GitHub](https://app.mintlify.com/settings/organization/github-app). + +
+### Integraciones +
+ +Para automatizaciones personalizadas y la automatización **Update from code changes**, puedes habilitar las [integraciones del agente](/es/agent/integrations) conectadas para que el agente pueda obtener contexto desde herramientas como Slack, Notion o Linear cuando se ejecuta la automatización. + +Para habilitar integraciones en una automatización, abre su configuración y selecciona las integraciones que quieres que el agente use en la sección **Available integrations**. Solo aparecen en la lista las integraciones ya conectadas para tu organización. Consulta [Integraciones del agente](/es/agent/integrations) para más información sobre cómo conectar integraciones. + +
+### Notificaciones de Slack +
+ +Envía mensajes de Slack a uno o más canales cuando se ejecuten las automatizaciones. + +Para activar las notificaciones de Slack: +1. Instala la [aplicación de Slack de Mintlify](/es/agent/slack) en tu espacio de trabajo. +2. Haz clic en **Turn on Slack notifications** en la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard. + + El botón para activar las notificaciones de Slack. + El botón para activar las notificaciones de Slack. + +3. Selecciona uno o más canales de notificación. +4. Haz clic en **Save changes**. + +Una vez activado, Mintlify publica en los canales seleccionados cuando: + +- Una automatización abre una pull request para revisión. +- Una pull request de una automatización lleva tres días esperando revisión. +- Una automatización fusiona una pull request o no logra completarse. + +
+### Instrucciones +
+ +Añade instrucciones opcionales que se agregan al prompt base de la automatización en cada ejecución. Úsalas para ajustar el estilo, el tono u otros comportamientos específicos del proyecto sin cambiar la lógica principal de la automatización. + +
+### Idiomas de destino +
+ +Cuando activas la automatización **Translate content**, selecciona uno o más idiomas para mantenerlos sincronizados con tu contenido fuente. + +- Mintlify lee los [idiomas](/es/organize/navigation#languages) definidos en tu `docs.json` para identificar tu idioma predeterminado y preselecciona los idiomas de destino que ya estén configurados. +- Debes seleccionar al menos un idioma de destino para guardar la automatización. +- No puedes seleccionar el idioma fuente como idioma de destino. + +Puedes añadir idiomas de destino en cualquier momento abriendo la configuración de la automatización y editando el campo **Translate to**. + + + +
+## Desactivar una automatización +
+ +1. Ve a la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. +2. Haz clic en el interruptor junto a una automatización para desactivarla. + +Cuando vuelves a activar una automatización programada o cambias su programación, Mintlify recalcula el próximo tiempo de ejecución a partir de la hora actual. Las automatizaciones desactivadas no conservan un tiempo de ejecución pendiente. + +
+## Ver el historial de ejecuciones +
+ +Cada automatización mantiene un registro de las ejecuciones pasadas, incluido el estado y un resumen de los cambios realizados. + +1. Ve a la página [Ejecuciones de automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. +2. Usa los menús desplegables para filtrar por automatizaciones o estado específicos. + + Página de ejecuciones de automatizaciones con los filtros de automatización y estado. + Página de ejecuciones de automatizaciones con los filtros de automatización y estado. + diff --git a/es/automations/reference.mdx b/es/automations/reference.mdx new file mode 100644 index 000000000..cac2b4d6d --- /dev/null +++ b/es/automations/reference.mdx @@ -0,0 +1,87 @@ +--- +title: "Automatizaciones predefinidas" +description: "Referencia de todas las automatizaciones predefinidas de Mintlify, incluidos el activador predeterminado, el modo de actualización, la compatibilidad con repositorios de contexto y la configuración requerida." +keywords: ["predefinida", "automatización", "predeterminada"] +--- + +Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de documentación más comunes. Cada automatización tiene un prompt base y una configuración predeterminada. Puedes personalizar el activador, el modo de actualización y las instrucciones desde la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard. + +
+## Automatizaciones de contenido autoactualizable +
+ +Las automatizaciones de contenido autoactualizable realizan actualizaciones basadas en el contexto que definas para que tu contenido se mantenga preciso y al día. + +
+### Actualizar a partir de cambios de código +
+ +Supervisa tus repositorios de código fuente y abre pull requests para actualizar el contenido ante cambios que afecten a los usuarios. Puedes ejecutar esta automatización según una programación, que generalmente consume menos créditos, o en cada pull request del código fuente. De forma predeterminada, esta automatización se ejecuta dos veces por semana (martes y jueves). + +Cuando ejecutas la automatización según una programación, el agente lee todas las pull requests del código fuente fusionadas desde la última vez que se ejecutó. Agrupa los cambios relacionados que requieren actualizaciones de contenido en una pull request en el repositorio de tu proyecto de Mintlify. Si hay pull requests sin fusionar de ejecuciones anteriores, el agente añade los cambios relevantes a las pull requests existentes. El agente cita de dónde provienen los cambios en tus repositorios de código fuente. + +Cuando ejecutas la automatización en cada pull request del código fuente, el agente abre una pull request de actualización de contenido cada vez que fusionas un cambio de código que requiere actualizaciones de contenido. Usa la variante basada en push cuando quieras que las actualizaciones de contenido aparezcan tan pronto como se publique el código, en lugar de agruparlas según una programación. + +Puedes habilitar las [integraciones del agente](/es/agent/integrations) para esta automatización para darle al agente contexto adicional desde herramientas como Slack o Linear al determinar qué actualizar. + +
+### Redactar el registro de cambios +
+ +Crea una entrada en el registro de cambios con una programación recurrente. Añade repositorios de código fuente como contexto para que el agente tenga más detalles sobre cómo cambió tu producto. Sin repositorios de contexto, el agente trabaja a partir de tus actualizaciones de contenido para escribir una entrada del registro de cambios. + +
+### Redactar mejoras a partir de conversaciones del asistente +
+ +Revisa las tendencias de preguntas de tu [asistente](/es/assistant/index) para identificar lagunas en tu contenido y luego abre una pull request para abordarlas. Cuantas más conversaciones del asistente tengan tus usuarios, más información tendrá el agente para trabajar. Ejecuta esta automatización de forma recurrente para mantener el contenido alineado con lo que los usuarios quieren saber sobre tu producto. + +
+### Redactar mejoras a partir de los comentarios de los usuarios +
+ +Revisa los [comentarios](/es/optimize/feedback) en las páginas —valoraciones con pulgar y comentarios escritos— y actualiza el contenido donde los usuarios han reportado problemas. El agente se centra en las páginas con señales negativas recurrentes en lugar de en comentarios aislados, por lo que los resultados mejoran a medida que se acumulan los comentarios. + +Debes habilitar la recopilación de comentarios en la página [Complementos](https://app.mintlify.com/products/addons) antes de poder usar esta automatización. + +
+## Automatizaciones de mantenimiento +
+ +Las automatizaciones de mantenimiento automatizan tareas rutinarias para mejorar la calidad y la consistencia de tu contenido. Puedes ejecutarlas con un activador de actualización de contenido o con una programación recurrente. + +Ejecutarlas con un activador de actualización de contenido mantiene tu contenido al día con un retraso mínimo. Ejecutarlas según una programación generalmente es más eficiente en créditos porque el agente agrupa el trabajo de varios cambios en una sola ejecución. La contrapartida es un retraso entre el cambio del contenido y el momento en que la automatización actúa sobre él. + +Cualquier automatización de mantenimiento habilitada se ejecuta en las pull requests creadas por las automatizaciones de contenido autoactualizable. Si la automatización de mantenimiento identifica cambios necesarios, el agente combina el trabajo en una sola pull request. Por ejemplo, si habilitas la automatización **Translate content**, el agente añade traducciones a cualquier pull request abierta por la automatización **Update from code changes**. + +
+### Traducir contenido +
+ +Traduce el contenido actualizado a los idiomas de destino que hayas seleccionado cada vez que se envíen cambios al repositorio de tu proyecto. Debes especificar al menos un idioma de destino. Mintlify lee los [idiomas](/es/organize/navigation#languages) definidos en tu `docs.json` y preselecciona los idiomas de destino que ya estén configurados. + +Para desactivar las traducciones de un idioma, elimina todos los archivos del directorio de ese idioma. No puedes desactivar las traducciones de un idioma que aún tenga contenido publicado. + + + +Encuentra y corrige los enlaces internos y externos rotos cada vez que se envían cambios de contenido al repositorio de tu proyecto. Útil para ejecutar después de grandes reorganizaciones de contenido o cuando los servicios externos a los que haces referencia cambian sus URLs. + +
+### Auditar metadatos de SEO +
+ +Audita y actualiza títulos, meta descripciones, encabezados y etiquetas canónicas cada vez que cambia el contenido. Añade instrucciones para alinear las sugerencias del agente con tu estrategia de SEO o tus palabras clave objetivo. + +
+### Corregir gramática y erratas +
+ +Encuentra y corrige erratas, errores ortográficos y errores gramaticales cada vez que cambia el contenido. Añade instrucciones para especificar excepciones para términos técnicos, nombres de productos o elecciones estilísticas intencionadas que el agente no debe modificar. + +
+### Aplicar la guía de estilo +
+ +Aplica reglas de voz, tono y redacción al contenido cada vez que cambia. Añade instrucciones para definir las reglas específicas que deseas que se apliquen o enlaza a tu guía de estilo. Cuanto más precisas sean tus instrucciones, más consistentes serán los resultados. diff --git a/es/changelog.mdx b/es/changelog.mdx index b7c4b5346..38ad5b2eb 100644 --- a/es/changelog.mdx +++ b/es/changelog.mdx @@ -5,7 +5,7 @@ rss: true noindex: true --- - +
## Borradores del editor @@ -24,12 +24,12 @@ noindex: true - **Reentrada rápida a la configuración:** Un banner te devuelve al paso de onboarding correcto si te vas a mitad de proceso. - **Nueva lista de verificación en el dashboard:** Una lista de verificación rediseñada en el dashboard hace seguimiento del progreso de la configuración después del onboarding. -
- ## Workflows en disponibilidad general +
+ ## Automatizaciones en disponibilidad general
- - **Insignia beta eliminada:** [Workflows](/es/workflows) sale de beta. - - **Limpieza de ejecuciones obsoletas:** Las ejecuciones de workflows en cola o estancadas durante mucho tiempo ahora expiran de forma fiable después de 25 horas. + - **Insignia beta eliminada:** [Automatizaciones](/es/automations) sale de beta. + - **Limpieza de ejecuciones obsoletas:** Las ejecuciones de automatizaciones en cola o estancadas durante mucho tiempo ahora expiran de forma fiable después de 25 horas.
## Rediseño del inicio de sesión @@ -91,7 +91,7 @@ noindex: true - Los resultados de búsqueda anclan al inicio de la página o a la sección cuyo título coincide, en lugar de a subsecciones arbitrarias. - Un frontmatter incorrecto ya no rompe las builds de páginas. - Las conexiones a Confluence ahora pasan por la interfaz de Nango Connect. - - El banner del inicio de Workflows muestra un toast cuando falla el borrado de un workflow personalizado, y prefiere `errorMessage` sobre un resumen para las ejecuciones fallidas. + - El banner del inicio de Automatizaciones muestra un toast cuando falla el borrado de una automatización personalizada, y prefiere un mensaje de error sobre un resumen para las ejecuciones fallidas. - Las etiquetas "Ran x ago" se actualizan durante el sondeo. - Se corrigió un doble conteo en el resumen de uso cuando los créditos pasaban al siguiente periodo. - Las insignias en directo en todo el producto ahora usan un icono de verificación consistente. @@ -103,12 +103,12 @@ noindex: true -
- ## Workflows +
+ ## Automatizaciones
- - **Recordatorios de revisiones pendientes:** Los [workflows](/es/workflows/reference) que abren pull requests ahora envían recordatorios por Slack cuando las revisiones quedan pendientes, para que las PR de documentación no se queden olvidadas. - - **Onboarding pulido:** El flujo de onboarding de workflows se ha simplificado y reelaborado de principio a fin, con textos más claros, logos de integraciones y una experiencia de conexión más fluida. + - **Recordatorios de revisiones pendientes:** Las [automatizaciones](/es/automations) que abren pull requests ahora envían recordatorios por Slack cuando las revisiones quedan pendientes, para que las PR de documentación no se queden olvidadas. + - **Onboarding pulido:** El flujo de onboarding de las automatizaciones se ha simplificado y reelaborado de principio a fin, con textos más claros, logos de integraciones y una experiencia de conexión más fluida.
## Agente de Slack @@ -146,7 +146,7 @@ noindex: true - Cambiar entre despliegues en el editor ahora funciona de forma fiable. - La vista del historial del agente se desplaza correctamente. - Los enlaces del dashboard ahora apuntan a la ruta correcta del editor. - - El filtro de búsqueda del selector de integraciones de workflows ahora filtra los resultados como se espera. + - El filtro de búsqueda del selector de integraciones de automatizaciones ahora filtra los resultados como se espera. - Los archivos del árbol del editor se ordenan alfabéticamente después de crear un nuevo archivo. - Los acordeones se abren automáticamente cuando navegas a su ancla hash en la misma página. - El agente del editor muestra su estado de exceso y de créditos antes de que envíes un mensaje. @@ -155,7 +155,7 @@ noindex: true - La selección de fechas futuras en el dashboard usa los estilos correctos. - +
## Editor @@ -180,13 +180,13 @@ noindex: true - **Archivos adjuntos:** Adjunta archivos directamente al agente — se envían a través de la API en lugar de incrustarse en el prompt. - **Interrumpir en medio del streaming:** Detén al agente mientras transmite una respuesta si quieres redirigirlo. -
- ## Workflows +
+ ## Automatizaciones
- - **Mejora la documentación a partir del feedback** ahora es un workflow dedicado que revisa los [comentarios recientes de las páginas](/es/optimize/feedback) y abre actualizaciones específicas de documentación a partir de lo que reportan los usuarios. Consulta [Workflows](/es/workflows/reference#draft-improvements-from-user-feedback). - - El workflow **Sync content with code** ha sido renombrado a **Self-updating site** para reflejar mejor lo que hace. - - Se actualizaron los títulos y los textos de los workflows en el panel para mayor claridad. + - **Redactar mejoras a partir de los comentarios de los usuarios:** esta nueva automatización revisa los [comentarios recientes de las páginas](/es/optimize/feedback) y abre pull requests basadas en lo que reportan los usuarios. + - La automatización **update from code changes** (antes sync content with code) ahora se ejecuta por defecto según una programación en lugar de activarse en cada cambio de código. Cuando se ejecuta, el agente analiza todos los cambios de código desde la última ejecución y abre una PR por cada conjunto relacionado de actualizaciones de documentación. Si hay una PR abierta de una ejecución anterior, los nuevos cambios se añaden a ella en lugar de crear una nueva PR. Esto significa que un release trabajado durante varias semanas produce una sola PR de docs para revisar, en lugar de una por commit. + - Se actualizaron los títulos y los textos de las automatizaciones en el panel para mayor claridad.
## API playground @@ -225,7 +225,7 @@ noindex: true - Los comandos de barra y la hoja de configuración de archivos se comportan correctamente en el árbol de archivos. - +
## Editor web @@ -239,13 +239,13 @@ noindex: true - **Navegación por árbol de archivos de forma predeterminada:** Los usuarios recién incorporados empiezan en la vista de árbol de archivos en lugar de la vista de lista heredada. - **Título de la pestaña del navegador:** El nombre de la pestaña del navegador ahora se actualiza dinámicamente para coincidir con el archivo activo, para que siempre sepas qué archivo estás editando. -
- ## Workflows +
+ ## Automatizaciones
- - Nuevo workflow **Draft improvements from assistant conversations** revisa tendencias en las preguntas de los usuarios y sugiere actualizaciones de documentación para abordar lagunas. Consulta [Workflows](/es/workflows/reference#draft-improvements-from-assistant-conversations). - - Los **repositorios de contexto** ahora se pueden configurar directamente para algunos workflows, para que puedas añadir los repos que un workflow debe consultar mientras se ejecuta. - - La configuración de workflows ahora se abre en un **panel lateral** en lugar de un modal, lo que facilita ajustar la configuración mientras revisas Workflow Runs. + - Nueva automatización **Draft improvements from assistant conversations** que revisa tendencias en las preguntas de los usuarios y sugiere actualizaciones de documentación para abordar lagunas. Consulta [Automatizaciones](/es/automations/reference#draft-improvements-from-assistant-conversations). + - Los **repositorios de contexto** ahora se pueden configurar directamente para algunas automatizaciones, para que puedas añadir los repos que una automatización debe consultar mientras se ejecuta. + - La configuración de las automatizaciones ahora se abre en un **panel lateral** en lugar de un modal, lo que facilita ajustar la configuración mientras revisas las ejecuciones de automatizaciones.
## Mejoras de búsqueda @@ -258,7 +258,7 @@ noindex: true ## Mejoras
- - **Slack Agent**: El [agente de Slack](/es/agent/slack) ahora admite **GitLab** además de GitHub para workflows que usan repositorios. + - **Slack Agent**: El [agente de Slack](/es/agent/slack) ahora admite **GitLab** además de GitHub para automatizaciones que usan repositorios. - **Navegación de la barra lateral:** El estado de navegación y la posición de desplazamiento de la barra lateral ahora se conservan al cambiar de página. - **Accesibilidad:** Mejoras de accesibilidad en la documentación, incluida la tabla de contenidos y el panel del agente en móvil. - **Esquemas AsyncAPI**: Los esquemas de array y combinatorios (`oneOf` / `anyOf` / `allOf`) ahora se expanden para mostrar sus atributos secundarios en la referencia de API. @@ -426,11 +426,11 @@ noindex: true Un nuevo asistente paso a paso en la página de configuración de Git te guía para conectar un repositorio de GitHub o GitLab por primera vez. Elige entre clonación con un clic o selección manual del repositorio, con soporte para selección de organización, configuración de rama y configuración de subdirectorio. -
- ## OAuth de GitLab para flujos de trabajo +
+ ## OAuth de GitLab para automatizaciones
- Los [flujos de trabajo](/automations) ahora soportan repositorios de GitLab a través de autenticación OAuth. Conecta tu cuenta de GitLab desde el dashboard para usar repositorios de GitLab como fuentes de documentación, repositorios de activación o repositorios de contexto en tus flujos de trabajo. El agente abre merge requests en GitLab de la misma manera que abre pull requests en GitHub. + Las [automatizaciones](/es/automations) ahora soportan repositorios de GitLab a través de autenticación OAuth. Conecta tu cuenta de GitLab desde el dashboard para usar repositorios de GitLab como fuentes de documentación, repositorios de activación o repositorios de contexto en tus automatizaciones. El agente abre merge requests en GitLab de la misma manera que abre pull requests en GitHub.
## Mejoras @@ -447,7 +447,7 @@ noindex: true ## Deprecaciones
- - Los flujos de trabajo basados en archivos están obsoletos. Crea flujos de trabajo desde el dashboard en su lugar. Los flujos de trabajo existentes desde archivos continúan funcionando, pero los nuevos flujos de trabajo deben crearse en el dashboard. + - Las automatizaciones basadas en archivos están obsoletas. Crea automatizaciones desde el dashboard en su lugar. Las automatizaciones existentes desde archivos continúan funcionando, pero las nuevas automatizaciones deben crearse en el dashboard.
## Correcciones de errores @@ -516,7 +516,7 @@ noindex: true - Mejoras de UX del CLI: URLs de inicio de sesión en gris para mayor claridad, formato de logs estandarizado y `mint status` ahora muestra la versión del CLI. - Soporte de la extensión OpenAPI `x-group` para organizar endpoints de API en grupos personalizados. - Las líneas horizontales (`
`) ahora son compatibles con el contenido MDX. - - Los [flujos de trabajo](/automations) ahora aparecen en la bandeja de entrada del dashboard para un seguimiento más fácil. La lista de flujos de trabajo también muestra los nombres de los PR para una identificación más rápida. + - Las [automatizaciones](/es/automations) ahora aparecen en la bandeja de entrada del dashboard para un seguimiento más fácil. La lista de automatizaciones también muestra los nombres de los PR para una identificación más rápida. - El comando `mint export` ahora incluye las páginas de referencia de API generadas a partir de especificaciones OpenAPI. - El menú de comandos de barra en el editor ha sido rediseñado con una mejor organización y descubrimiento. - Se mejoró la interfaz del flujo de publicación del editor y la interfaz de creación de páginas. @@ -528,7 +528,7 @@ noindex: true
- Se corrigió que los IDs de encabezados personalizados no se procesaban antes del análisis MDX, lo que podía causar que los anchors se rompieran en ciertas páginas. - - Se corrigió que la plantilla de flujo de trabajo de auditoría de SEO y metadatos modificaba incorrectamente las páginas de endpoints de API. + - Se corrigió que la plantilla de automatización de auditoría de SEO y metadatos modificaba incorrectamente las páginas de endpoints de API. - Se corrigió el ajuste de texto de la etiqueta de obsoleto en el dashboard. - Se corrigió que el formato en línea (negrita, cursiva, código) no se aplicaba correctamente en el editor en ciertos contextos. - Se corrigió que los colores de los iconos de carpeta de directorios no coincidían con el tema configurado. @@ -566,7 +566,7 @@ noindex: true - Se rediseñó la página de configuración del editor con un diseño mejorado y soporte de autoguardado. - Las páginas generadas automáticamente a partir de especificaciones OpenAPI ahora aparecen en el editor web como entradas de solo lectura. - Soporte de video en la [vista previa en vivo](/es/editor/live-preview). Los archivos mp4, webm y mov incrustados ahora se renderizan correctamente durante el desarrollo local. - - Los [flujos de trabajo](/automations) ahora se pueden deshabilitar y volver a habilitar desde el dashboard. + - Las [automatizaciones](/es/automations) ahora se pueden deshabilitar y volver a habilitar desde el dashboard. - Los análisis del asistente ahora muestran el uso desglosado por fuente (web vs API) en el dashboard. - La búsqueda MCP autenticada ahora filtra correctamente los resultados según los grupos de autenticación del usuario. - Las respuestas del agente de Slack ahora muestran resúmenes de llamadas a herramientas en lugar de llamadas a herramientas sin procesar para una información más clara de lo que el agente está haciendo. @@ -582,7 +582,7 @@ noindex: true - Se corrigió el desplazamiento del diseño causado por la barra de herramientas de selección de texto. - Se corrigió la detección visual de diferencias de badges e iconos en el editor. - Se corrigió que el título y la descripción de OpenAPI no se resolvían para páginas referenciadas por ruta de archivo. - - Se corrigió que el toggle de automerge de [flujos de trabajo](/automations) no se deshabilitaba correctamente cuando se desactivaba. + - Se corrigió que el toggle de automerge de [automatizaciones](/es/automations) no se deshabilitaba correctamente cuando se desactivaba. - Se corrigió que el API playground incluía campos de objetos opcionales con hijos requeridos en los cuerpos de solicitud generados. - Se corrigió la activación por teclado de la casilla de verificación de selección en la tabla de análisis de feedback. @@ -644,7 +644,7 @@ Una nueva opción [`api.playground.credentials`](/es/api-playground/overview) en - Los [IDs de encabezado personalizados](/es/create/text#custom-heading-ids) ahora son compatibles. Los resultados de búsqueda enlazan directamente a las secciones que usan IDs personalizados. - Las entradas de navegación en `docs.json` ahora admiten enlaces ancla (enlaces `#`). -- El dashboard de workflows fue rediseñado con vista de tarjetas, historial de ejecución más claro, menús desplegables de acciones y estados vacíos mejorados. +- El dashboard de automatizaciones fue rediseñado con vista de tarjetas, historial de ejecución más claro, menús desplegables de acciones y estados vacíos mejorados. - La navegación del editor ahora se sincroniza con el servidor para cambios persistentes y resolución de conflictos multiusuario. - La búsqueda MCP ahora respeta los permisos de autenticación, por lo que los resultados de búsqueda solo incluyen páginas a las que el usuario tiene acceso. - [Heap analytics](/es/integrations/analytics/heap) ahora reenvía correctamente las vistas de página y los eventos personalizados. @@ -701,9 +701,9 @@ Invita a múltiples miembros del equipo a tu organización a la vez desde el das
- Las fotos de perfil de los usuarios ahora se muestran en todo el dashboard para una experiencia más personalizada. -- Las plantillas de workflows se actualizaron con prompts mejorados. -- El historial de ejecución de workflows ahora se puede ver desde el dashboard con la capacidad de monitorear el estado y cerrar PRs. -- Las notificaciones de Slack para workflows ahora son configurables desde el dashboard. +- Las plantillas de automatizaciones se actualizaron con prompts mejorados. +- El historial de ejecución de automatizaciones ahora se puede ver desde el dashboard con la capacidad de monitorear el estado y cerrar PRs. +- Las notificaciones de Slack para automatizaciones ahora son configurables desde el dashboard. - Mejoras de rendimiento del editor: se corrigió la latencia de escritura y el bloqueo de persistencia en repositorios grandes, se virtualizaron las listas de archivos para repositorios con muchos archivos. - Se eliminó el cambio de diseño de las tarjetas en la carga inicial de la página. - Se mejoró la responsividad del selector de fechas en las analíticas del dashboard. @@ -728,19 +728,19 @@ Invita a múltiples miembros del equipo a tu organización a la vez desde el das - + -
- ## Plantillas de workflows +
+ ## Plantillas de automatizaciones
-Crea [workflows](/automations) más rápido con plantillas predefinidas en el [dashboard](https://dashboard.mintlify.com/products/workflows). Elige entre plantillas para generación de changelogs, sincronización de documentación de API, borradores de documentación de funcionalidades, detección de enlaces rotos, auditorías de SEO y más. Las plantillas incluyen prompts optimizados y configuraciones de activación para ayudarte a comenzar rápidamente. +Crea [automatizaciones](/es/automations) más rápido con plantillas predefinidas en el [dashboard](https://app.mintlify.com/products/automations). Elige entre plantillas para generación de changelogs, sincronización de documentación de API, borradores de documentación de funcionalidades, detección de enlaces rotos, auditorías de SEO y más. Las plantillas incluyen prompts optimizados y configuraciones de activación para ayudarte a comenzar rápidamente. -
- ## Comando CLI de workflows +
+ ## Comando CLI de automatizaciones
-Crea archivos de [workflows](/automations) desde la línea de comandos con el comando CLI `mint workflow`. Los prompts interactivos te guían a través del nombre, el trigger, el contexto y las instrucciones. +Crea archivos de [automatizaciones](/es/automations) desde la línea de comandos con el comando CLI `mint automation`. Los prompts interactivos te guían a través del nombre, el trigger, el contexto y las instrucciones.
## Agent API v2 @@ -767,7 +767,7 @@ Visualiza el feedback desglosado por páginas individuales en tu dashboard de [a - Incrustaciones de YouTube y Loom disponibles en el menú de comandos con barra del editor - Contenido del footer y navbar localizado por idioma - El assistant de Slack muestra indicadores de estado mientras procesa -- Los workflows ahora pueden enviar notificaciones de Slack con el estado de auto-merge +- Las automatizaciones ahora pueden enviar notificaciones de Slack con el estado de auto-merge - El editor ahora admite corrección ortográfica - Mejoras en el diseño del dashboard para vistas móviles y responsivas @@ -782,8 +782,8 @@ Visualiza el feedback desglosado por páginas individuales en tu dashboard de [a - Se corrigieron problemas de estilo en la exportación a PDF - Se corrigió el footer oculto en páginas personalizadas para los temas Mint, Maple, Willow y Linden - Se corrigieron las rutas `.md` que no generaban títulos a partir de slugs -- Se corrigieron los workflows de cron creados a través del dashboard que no se activaban automáticamente -- Se corrigieron las ejecuciones recursivas de workflows +- Se corrigieron las automatizaciones de cron creadas a través del dashboard que no se activaban automáticamente +- Se corrigieron las ejecuciones recursivas de automatizaciones - Se corrigió que el agente volviera a crear un PR cuando se le pedían cambios de seguimiento - Se corrigieron los errores de sesión del agente para sesiones multilingües @@ -808,7 +808,7 @@ Visualiza el feedback desglosado por páginas individuales en tu dashboard de [a ## Mejoras - * Los flujos de trabajo ahora admiten hasta 50 ejecuciones por día, frente a las 20 anteriores. + * Las automatizaciones ahora admiten hasta 50 ejecuciones por día, frente a las 20 anteriores. * Ahora se admite la [URL base completa](/es/organize/settings-api) en el área de pruebas de la API configurando `api.url` en `docs.json`. * Se actualizó el diseño del dashboard con una navigation mejorada y acceso en la barra lateral para las páginas del editor y de configuración. * Se rediseñó la barra de búsqueda del editor con una mejor experiencia de usuario para encontrar archivos y navegar hasta ellos. @@ -826,12 +826,12 @@ Visualiza el feedback desglosado por páginas individuales en tu dashboard de [a * Se corrigió el comportamiento del zoom en móviles para los campos de entrada. - - ## Flujos de trabajo + + ## Automatizaciones - Automatiza tareas de documentación con [flujos de trabajo](/automations). Configura automatizaciones programadas o activadas por eventos que ejecutan el agente para actualizar tu documentación. + Automatiza tareas de documentación con [automatizaciones](/es/automations). Configura automatizaciones programadas o activadas por eventos que ejecutan el agente para actualizar tu documentación. - Los flujos de trabajo están en beta y disponibles en todos los planes. + Las automatizaciones están en beta y disponibles en todos los planes. ## Comentarios y sugerencias diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index 591793e66..76bfaa376 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -81,7 +81,7 @@ mint status ## `mint workflow`
-Crea, lista y elimina [workflows](/es/workflows) desde la terminal. Requiere autenticación con `mint login`. +Crea, lista y elimina [workflows](/es/automations) desde la terminal. Requiere autenticación con `mint login`. ```bash mint workflow [flags] diff --git a/es/credits.mdx b/es/credits.mdx index ead794d7f..7f16cf5ee 100644 --- a/es/credits.mdx +++ b/es/credits.mdx @@ -1,6 +1,6 @@ --- title: "Precios por créditos" -description: "Cómo funcionan los créditos de Mintlify para respuestas del Assistant, ejecuciones del agente y workflows, incluida la forma en que facturamos niveles, excedentes y acumulados." +description: "Cómo funcionan los créditos de Mintlify para respuestas del Assistant, ejecuciones del agente y automatizaciones, incluida la forma en que facturamos niveles, excedentes y acumulados." keywords: ["créditos", "facturación", "precios", "chat con IA", "mensajes", "niveles", "uso"] --- @@ -8,7 +8,7 @@ Algunas funciones de Mintlify consumen créditos. * Respuestas del Assistant * Ejecuciones del agente en el editor o en Slack -* Ejecuciones de workflows +* Ejecuciones de automatizaciones Para obtener la información de precios más actualizada, consulta la [página de Precios](https://mintlify.com/pricing) o revisa la página de [Uso](https://app.mintlify.com/settings/organization/usage) en tu panel. @@ -53,9 +53,9 @@ Las distintas funciones consumen diferentes cantidades de créditos por interacc | Ejecución del agente en el editor | 115 | | Ejecución del agente en Slack | 110 | -Los workflows también consumen créditos cuando se ejecutan: +Las automatizaciones también consumen créditos cuando se ejecutan: -| Workflow | Promedio de créditos por ejecución | +| Automatización | Promedio de créditos por ejecución | |:---------|:-----------------------------------| | Actualización a partir de cambios de código | 180 | | Actualización a partir de conversaciones con el assistant | 212 | @@ -72,7 +72,7 @@ Los workflows también consumen créditos cuando se ejecutan: Utiliza los promedios de la sección [Cómo funcionan los créditos](/es/credits#how-credits-work) para estimar tus necesidades mensuales de créditos. -Por ejemplo, si tu sitio de documentación maneja 500 respuestas del Assistant por mes, eso equivale aproximadamente a 11,500 créditos (500 × 23). Agregar un workflow semanal de detección de enlaces rotos añade unos 1,140 créditos al mes (4 × 285). +Por ejemplo, si tu sitio de documentación maneja 500 respuestas del Assistant por mes, eso equivale aproximadamente a 11,500 créditos (500 × 23). Agregar una automatización semanal de detección de enlaces rotos añade unos 1,140 créditos al mes (4 × 285). Después de usar las funciones que consumen créditos durante un mes, revisa tus patrones de uso para ver si debes ajustar tu nivel. @@ -80,6 +80,6 @@ Después de usar las funciones que consumen créditos durante un mes, revisa tus ## Optimización de costos
-**Programa los workflows en lugar de ejecutarlos en cada push.** Los workflows como las auditorías SEO, las verificaciones de estilo de redacción y la detección de enlaces rotos no necesitan ejecutarse en cada cambio de código. Ejecutarlos en un cron diario o semanal en vez de en cada push reduce significativamente el consumo de créditos sin un impacto relevante en la calidad del contenido. +**Programa las automatizaciones en lugar de ejecutarlas en cada push.** Las automatizaciones como las auditorías SEO, las verificaciones de estilo de redacción y la detección de enlaces rotos no necesitan ejecutarse en cada cambio de código. Ejecutarlas en un cron diario o semanal en vez de en cada push reduce significativamente el consumo de créditos sin un impacto relevante en la calidad del contenido. -**Monitorea tus patrones de uso.** La página de [Uso](https://app.mintlify.com/settings/organization/usage) en tu panel muestra un desglose por categoría de función. Si un workflow en particular está consumiendo más créditos de lo esperado, revisa su disparador o cualquier instrucción personalizada. +**Monitorea tus patrones de uso.** La página de [Uso](https://app.mintlify.com/settings/organization/usage) en tu panel muestra un desglose por categoría de función. Si una automatización en particular está consumiendo más créditos de lo esperado, revisa su disparador o cualquier instrucción personalizada. diff --git a/es/dashboard/audit-logs.mdx b/es/dashboard/audit-logs.mdx index 8576a662d..25e6703ba 100644 --- a/es/dashboard/audit-logs.mdx +++ b/es/dashboard/audit-logs.mdx @@ -55,7 +55,7 @@ Filtra los registros de auditoría para encontrar actividades específicas. | Facturación | Actualizaciones de suscripciones, compras de complementos y visualización de facturas. | | Cuota | Cambios en la política de excedentes y en la configuración de alertas. | | Usuario | Configuración de notificaciones de usuarios individuales. | -| Workflows | Configuraciones de workflows y gestión de repositorios. | +| Automatizaciones | Configuraciones de automatizaciones y gestión de repositorios. | | Registro de auditoría | Visualización y exportaciones del registro de auditoría. | | Auth | Intentos de inicio de sesión, cierres de sesión y creación de sesiones. | diff --git a/es/guides/configure-automerge.mdx b/es/guides/configure-automerge.mdx index 1c8c4d03e..0606fe93b 100644 --- a/es/guides/configure-automerge.mdx +++ b/es/guides/configure-automerge.mdx @@ -5,10 +5,10 @@ description: "Configura flujos de GitHub para fusionar automáticamente los pull keywords: ["automerge", "ruleset", "protección de rama", "bypass"] --- -Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para que la aplicación pueda crear y fusionar pull requests sin que los requisitos de revisión y verificaciones de estado la bloqueen. Esto te permite configurar [flujos de trabajo](/automations/index) para fusionar automáticamente los cambios a `main`. +Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para que la aplicación pueda crear y fusionar pull requests sin que los requisitos de revisión y verificaciones de estado la bloqueen. Esto te permite configurar [automatizaciones](/es/automations/index) para fusionar automáticamente los cambios a `main`. - La aplicación GitHub de Mintlify debe tener permisos de bypass en **todos** los rulesets que apunten a tu rama de implementación, incluyendo los rulesets definidos a nivel de organización y a nivel de repositorio. Si algún ruleset no tiene la entrada de bypass, el flujo de trabajo crea un PR, pero no lo fusiona. + La aplicación GitHub de Mintlify debe tener permisos de bypass en **todos** los rulesets que apunten a tu rama de implementación, incluyendo los rulesets definidos a nivel de organización y a nivel de repositorio. Si algún ruleset no tiene la entrada de bypass, la automatización crea un PR, pero no lo fusiona.
@@ -51,4 +51,4 @@ Repite estos pasos para cada ruleset que se aplique a tu rama de implementación
1. **Para colaboradores**: Abre un PR que apunte a `main`. Confirma que aún requiere aprobación y verificaciones de estado exitosas antes de que puedas fusionar. -2. **Para flujos de trabajo**: Activa un flujo de trabajo con automerge habilitado. Confirma que el flujo de trabajo se ejecuta y fusiona exitosamente un PR. +2. **Para automatizaciones**: Activa una automatización con automerge habilitado. Confirma que la automatización se ejecuta y fusiona exitosamente un PR. diff --git a/es/guides/improving-docs.mdx b/es/guides/improving-docs.mdx index 667915a92..ba10037d3 100644 --- a/es/guides/improving-docs.mdx +++ b/es/guides/improving-docs.mdx @@ -123,7 +123,7 @@ Medir solo es útil si impulsa la acción. Algunos enfoques para decidir qué co - **Enfócate en los recorridos clave del usuario.** Identifica las tres a cinco tareas más críticas para el éxito de tu producto y asegúrate de que la documentación que respalda esas tareas sea excelente antes de preocuparte por el resto. - Usa [flujos de trabajo](/automations) para automatizar mejoras recurrentes, como abrir un pull request con correcciones sugeridas para páginas marcadas por puntuaciones de comentarios bajas. + Usa [automatizaciones](/es/automations) para automatizar mejoras recurrentes, como abrir un pull request con correcciones sugeridas para páginas marcadas por puntuaciones de comentarios bajas.
diff --git a/es/guides/index.mdx b/es/guides/index.mdx index 4d9c68f10..641ccc347 100644 --- a/es/guides/index.mdx +++ b/es/guides/index.mdx @@ -19,8 +19,8 @@ Ante todo, ten en cuenta las necesidades y objetivos de tus usuarios. Documenta Utiliza herramientas impulsadas por IA para acelerar tu flujo de trabajo de documentación. * [Crear un assistant dentro de tu aplicación](/es/guides/assistant-embed): Tutorial que enseña cómo agregar un chat bot de IA en una app de React para ayudar a los usuarios a encontrar respuestas en tu documentación. -* [Configurar automerge](/es/guides/configure-automerge): Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para habilitar la fusión automática de flujos de trabajo. -* [Usar workflows](/es/guides/use-workflows): Elige el trigger de workflow adecuado, escribe instrucciones efectivas y obtén resultados consistentes del mantenimiento automatizado de contenido. +* [Configurar automerge](/es/guides/configure-automerge): Agrega la aplicación GitHub de Mintlify a la lista de bypass de un ruleset para habilitar la fusión automática para automatizaciones. +* [Usar automatizaciones](/es/guides/use-automations): Elige el activador de automatización adecuado, escribe instrucciones efectivas y obtén resultados consistentes del mantenimiento automatizado de contenido. * [Claude Code](/es/guides/claude-code), [Cursor](/es/guides/cursor), [Windsurf](/es/guides/windsurf): Guías para usar asistentes de programación con IA para mantener la documentación. * [GEO](/es/guides/geo): Mejores prácticas para optimizar tu documentación para motores de búsqueda y respuesta basados en IA. diff --git a/es/guides/internationalization.mdx b/es/guides/internationalization.mdx index 5ee709111..5dba32563 100644 --- a/es/guides/internationalization.mdx +++ b/es/guides/internationalization.mdx @@ -327,7 +327,7 @@ Mantén las traducciones precisas y sincronizadas con tu contenido original. ### Traducciones automatizadas
-Para soluciones de traducción automática, [configura un workflow](/automations) para ejecutar el agente de forma programada o en respuesta a cambios enviados al repositorio. +Para soluciones de traducción automática, [configura una automatización](/es/automations) para ejecutar el agente de forma programada o en respuesta a cambios enviados al repositorio.
### Proveedores de traducción externos diff --git a/es/guides/maintenance.mdx b/es/guides/maintenance.mdx index d9316712b..a81dfc8fa 100644 --- a/es/guides/maintenance.mdx +++ b/es/guides/maintenance.mdx @@ -62,7 +62,7 @@ Rastrear manualmente las fechas de revisión en cientos de páginas no escala. A - Usa [verificaciones de CI](/es/deploy/ci) para aplicar requisitos de frontmatter y detectar enlaces rotos en cada pull request - Usa [workflows](/automations) para ejecutar verificaciones de mantenimiento automatizadas de forma programada: marcando contenido obsoleto, verificando metadatos faltantes o detectando páginas con puntuaciones de retroalimentación consistentemente bajas. + Usa [automatizaciones](/es/automations) para ejecutar verificaciones de mantenimiento automatizadas de forma programada: marcando contenido obsoleto, verificando metadatos faltantes o detectando páginas con puntuaciones de retroalimentación consistentemente bajas.
diff --git a/es/guides/navigation.mdx b/es/guides/navigation.mdx index 3b65ad3bd..fc3f06a00 100644 --- a/es/guides/navigation.mdx +++ b/es/guides/navigation.mdx @@ -149,7 +149,7 @@ Una cadencia práctica: - **Revisa la estructura de nivel superior anualmente.** A medida que la documentación crece, lo que funcionaba con 20 páginas puede no funcionar con 200. - Usa [workflows](/automations) para automatizar verificaciones recurrentes como identificar páginas con puntuaciones de retroalimentación bajas o señalar elementos de navegación que rara vez reciben clics. + Usa [automatizaciones](/es/automations) para automatizar verificaciones recurrentes como identificar páginas con puntuaciones de retroalimentación bajas o señalar elementos de navegación que rara vez reciben clics. Para configurar la navegación en Mintlify—pestañas, grupos, anclas y orden de páginas—consulta la [referencia de navegación](/es/organize/navigation). diff --git a/es/guides/seo.mdx b/es/guides/seo.mdx index fdeaffe52..673013954 100644 --- a/es/guides/seo.mdx +++ b/es/guides/seo.mdx @@ -148,7 +148,7 @@ Un enfoque práctico: - Comprueba los enlaces rotos con `mint broken-links` antes de publicar - Usa [workflows](/automations) para automatizar tareas de mantenimiento SEO. + Usa [automatizaciones](/es/automations) para automatizar tareas de mantenimiento SEO. La documentación desactualizada crea un segundo problema más allá del SEO: si los usuarios encuentran tu página a través de búsqueda pero la información es incorrecta, pierden confianza en tu documentación. diff --git a/es/guides/style-and-tone.mdx b/es/guides/style-and-tone.mdx index 6e2dcf3e5..b6a1f0c23 100644 --- a/es/guides/style-and-tone.mdx +++ b/es/guides/style-and-tone.mdx @@ -145,7 +145,7 @@ Los principios de escritura solo perduran si son parte de un flujo de trabajo re - **Guías de estilo existentes:** En lugar de escribir reglas desde cero, comienza con una guía establecida. La [Google Developer Documentation Style Guide](https://developers.google.com/style), la [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) y la [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse) son todas gratuitas y ampliamente utilizadas. - Usa un [workflow](/automations) para ejecutar una auditoría de estilo de forma programada o cada vez que se envíen cambios a tu repositorio de documentación. + Usa una [automatización](/es/automations) para ejecutar una auditoría de estilo de forma programada o cada vez que se envíen cambios a tu repositorio de documentación.
diff --git a/es/guides/use-automations.mdx b/es/guides/use-automations.mdx new file mode 100644 index 000000000..4ecf44753 --- /dev/null +++ b/es/guides/use-automations.mdx @@ -0,0 +1,126 @@ +--- +title: "Usar automatizaciones" +description: "Usa las automatizaciones de Mintlify para automatizar el mantenimiento recurrente de la documentación: elige el activador adecuado, escribe instrucciones eficaces y obtén resultados consistentes del agente." +keywords: ["automatizaciones", "automatización", "automatizar", "guía de automatización", "instrucciones de automatización", "automatización del agente", "autoactualización"] +--- + +Las automatizaciones ejecutan el agente automáticamente para que tu contenido se mantenga preciso sin esfuerzo manual. Esta guía explica cómo elegir la automatización adecuada, configurarla con eficacia y escribir instrucciones que produzcan resultados consistentes. + +
+## Cuándo usar automatizaciones +
+ +Las automatizaciones son ideales para tareas que son: + +- **Repetitivas**: la misma tarea se ejecuta con regularidad según una programación previsible o cada vez que ocurre un evento concreto. +- **Que consumen tiempo**: tareas que llevan tiempo si se hacen manualmente, pero siguen un patrón consistente. +- **Reactivas**: tareas que deben suceder automáticamente en respuesta a cambios de código o de contenido, como actualizar la documentación después de lanzar una funcionalidad. + +Para tareas puntuales o exploratorias, usa el agente directamente en el [dashboard](https://app.mintlify.com) o desde Slack. + +
+## Elige un activador +
+ +Cada automatización se ejecuta con uno de tres tipos de activadores. Elige el que se ajuste a cuándo necesitas que se realice el trabajo. + +| Activador | Úsalo cuando | +|---|---| +| Actualización de contenido | La tarea debe ejecutarse siempre que cambie el contenido de tu proyecto: traducir nuevas páginas, corregir enlaces rotos o auditar metadatos de SEO. | +| Cambio de código | La tarea debe ejecutarse cuando cambia el código fuente: actualizar especificaciones de API o documentación después de fusionar una PR. | +| Programación personalizada | La tarea debe ejecutarse con una cadencia fija independientemente de otros eventos: publicar registros de cambios semanales o ejecutar comprobaciones gramaticales periódicas. | + +
+## Automatizaciones predefinidas +
+ +Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de contenido más comunes. Activa cualquiera de ellas desde la página [Automatizaciones](https://app.mintlify.com/products/automations) de tu dashboard. + +Consulta [Automatizaciones predefinidas](/es/automations/reference) para más detalles. + +
+## Automatizaciones personalizadas +
+ +Crea una automatización personalizada para tareas que no cubran las opciones predefinidas. Las automatizaciones personalizadas te dan control total sobre el activador, las instrucciones y los repositorios de contexto. + +Consulta [Crear una automatización personalizada](/es/automations/create) para los pasos de configuración. + +
+### Escribir instrucciones eficaces +
+ +Las instrucciones de las automatizaciones personalizadas son prompts que el agente sigue en cada ejecución. La calidad de tus instrucciones afecta directamente a la consistencia de los resultados. + +**Describe el resultado, no solo la tarea.** Dile al agente cómo se ve "terminado". + + +```text Menos eficaz +Review the API reference pages. +``` + +```text Más eficaz +Review every page in the /api-reference directory. For each endpoint, confirm that the request parameters, response fields, and example payloads match the OpenAPI spec in the api/openapi.yaml file. Open a pull request with corrections for any discrepancies you find. +``` + + +**Escribe un procedimiento.** Los agentes siguen las instrucciones paso a paso con más fiabilidad que los prompts abiertos. + +```text Procedimiento de ejemplo +1. Read the merged pull request diff from the trigger repository. +2. Identify any changed API endpoints, parameters, or response shapes. +3. Search the documentation for pages that reference those endpoints. +4. Update the affected pages to match the changes in the pull request. +5. Open a pull request with a summary of the pages you changed and why. +``` + +**Mantén un alcance acotado.** Una automatización que hace una sola cosa bien es más fiable que una que intenta hacer muchas cosas. Divide las tareas complejas entre varias automatizaciones. + +**Especifica archivos y directorios.** Cuanto más preciso seas sobre dónde debe mirar el agente, menos tiempo dedicará a buscar. + +```text Ejemplo con rutas específicas +Check every MDX file in the /content directory for broken internal links (links beginning with /). +For each broken link, either fix the path or remove the link if no replacement exists. +``` + +
+### Usar repositorios de contexto +
+ +Para automatizaciones personalizadas y algunas automatizaciones predefinidas, puedes añadir repositorios de contexto que el agente lee cuando se ejecuta la automatización. + +Añade repositorios de contexto cuando: +- Tu contenido haga referencia a código, APIs o configuración que vive en un repositorio separado. +- Quieras que el agente compare tu contenido con el código fuente al decidir qué actualizar. +- El prompt de la automatización haga referencia a archivos fuera del repositorio de tu proyecto de Mintlify. + +Puedes añadir hasta 10 repositorios de contexto por automatización. + +
+### Modo de actualización +
+ +Decide cuánta revisión deseas antes de que los cambios se publiquen. + +- **Automático**: los cambios se fusionan directamente en el repositorio de tu proyecto de Mintlify sin revisión. Ideal para tareas de bajo riesgo y alta frecuencia, como traducciones, comprobaciones gramaticales y correcciones de enlaces. +- **Requiere revisión**: el agente abre una pull request y una persona la revisa antes de fusionarla. Ideal para tareas que cambian el significado del contenido, como sincronizar con cambios de código o actualizar referencias de API. + +
+## Controlar el uso de créditos +
+ +Cada ejecución de una automatización consume créditos. Por ejemplo, la mayoría de las ejecuciones de la automatización **update from code changes** cuestan entre 40 y 180 créditos. Las ejecuciones complejas que actualizan muchas páginas cuestan más. + +Programar tareas cron para que se ejecuten en momentos específicos te da un control más preciso sobre el uso de créditos. Por ejemplo, ejecuta una automatización una vez al día o una vez a la semana para saber exactamente cuántas pull requests crea al mes. Las automatizaciones activadas por push pueden variar más de un mes a otro porque dependen de la frecuencia con la que cambian el contenido o el código. + +
+## Revisar y mejorar los resultados de las automatizaciones +
+ +Las automatizaciones se ejecutan automáticamente, pero se benefician de revisiones periódicas. + +1. Abre la pestaña **Runs** en la página [Automatizaciones](https://app.mintlify.com/products/automations) para ver el historial reciente de ejecuciones y su estado. +2. Haz clic en una ejecución para leer el resumen del agente y revisar las pull requests que haya abierto. +3. Si los resultados son inconsistentes, refina tus instrucciones: añade procedimientos más específicos, acota el ámbito de archivos o divide la automatización en tareas más pequeñas. + +Unos pocos ciclos de revisión tras habilitar una nueva automatización suelen ser suficientes para ajustar las instrucciones. diff --git a/es/guides/use-workflows.mdx b/es/guides/use-workflows.mdx deleted file mode 100644 index e82e4c105..000000000 --- a/es/guides/use-workflows.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "Usar workflows" -description: "Usa los workflows de Mintlify para automatizar el mantenimiento de tu documentación: elige el trigger, escribe instrucciones claras y obtén buenos resultados." -keywords: ["workflows", "automatización", "automatizar", "guía de workflows", "instrucciones de workflow", "automatización del agente", "autoactualizable"] ---- - -Los workflows ejecutan el agente automáticamente para que tu contenido se mantenga preciso sin esfuerzo manual. Esta guía cubre cómo elegir el workflow adecuado, configurarlo de forma efectiva y escribir instrucciones que produzcan resultados consistentes. - -
- ## Cuándo usar workflows -
- -Los workflows son ideales para tareas que son: - -- **Repetitivas**—La misma tarea se ejecuta con regularidad según una programación predecible o cada vez que ocurre un evento específico. -- **Lentas**—Tareas que llevan tiempo realizar manualmente pero siguen un patrón consistente. -- **Reactivas**—Tareas que deben ocurrir automáticamente en respuesta a cambios de código o contenido, como actualizar la documentación tras el lanzamiento de una funcionalidad. - -Para tareas puntuales o exploratorias, usa el agente directamente en el [panel](https://app.mintlify.com) o desde Slack. - -
- ## Elegir un trigger -
- -Cada workflow se ejecuta con uno de tres tipos de trigger. Elige el que coincida con cuándo necesitas que se realice el trabajo. - -| Trigger | Cuándo usarlo | -|---|---| -| Actualización de contenido | La tarea debe ejecutarse cada vez que cambie el contenido de tu proyecto: traducir páginas nuevas, reparar enlaces rotos o auditar metadatos de SEO. | -| Cambio de código | La tarea debe ejecutarse cuando cambia el código fuente: actualizar especificaciones de API o documentación tras el merge de una PR. | -| Programación personalizada | La tarea debe ejecutarse con una cadencia fija sin importar lo demás: publicar changelogs semanales o ejecutar verificaciones gramaticales periódicas. | - -
- ## Workflows predefinidos -
- -Mintlify incluye workflows predefinidos para las tareas más comunes de mantenimiento de contenido. Activa cualquiera de ellos desde la página [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) de tu panel. - -Consulta [Workflows predefinidos](/es/workflows/reference) para más detalles. - -
- ## Workflows personalizados -
- -Crea un workflow personalizado para tareas que no están cubiertas por las opciones predefinidas. Los workflows personalizados te dan control total sobre el trigger, las instrucciones y los repositorios de contexto. - -Consulta [Crear un workflow personalizado](/es/workflows/create) para los pasos de configuración. - -
- ### Escribir instrucciones efectivas -
- -Las instrucciones de un workflow personalizado son prompts que el agente sigue en cada ejecución. La calidad de tus instrucciones afecta directamente a la consistencia de los resultados. - -**Describe el resultado, no solo la tarea.** Indica al agente cómo debe verse el resultado final. - - -```text Menos efectivo -Revisa las páginas de referencia de la API. -``` - -```text Más efectivo -Revisa cada página del directorio /api-reference. Para cada endpoint, confirma que los parámetros de la solicitud, los campos de respuesta y los payloads de ejemplo coincidan con la especificación OpenAPI en el archivo api/openapi.yaml. Abre una pull request con correcciones para cualquier discrepancia que encuentres. -``` - - -**Escribe un procedimiento.** Los agentes siguen instrucciones paso a paso de forma más fiable que prompts abiertos. - -```text Ejemplo de procedimiento -1. Lee el diff de la pull request mergeada del repositorio de origen. -2. Identifica los endpoints, parámetros o formas de respuesta de la API que cambiaron. -3. Busca en la documentación las páginas que hacen referencia a esos endpoints. -4. Actualiza las páginas afectadas para que coincidan con los cambios de la pull request. -5. Abre una pull request con un resumen de las páginas que cambiaste y por qué. -``` - -**Mantén el alcance acotado.** Un workflow que hace una cosa bien es más fiable que uno que intenta hacer muchas. Divide las tareas complejas en varios workflows. - -**Especifica archivos y directorios.** Cuanto más preciso seas sobre dónde debe mirar el agente, menos tiempo dedicará a buscar. - -```text Ejemplo con rutas específicas -Revisa cada archivo MDX en el directorio /content para detectar enlaces internos rotos (enlaces que comienzan con /). -Para cada enlace roto, corrige la ruta o elimina el enlace si no existe sustitución. -``` - -
- ### Usar repositorios de contexto -
- -Para workflows personalizados y algunos workflows predefinidos, puedes añadir repositorios de contexto que el agente lee cuando se ejecuta el workflow. - -Añade repositorios de contexto cuando: -- Tu contenido haga referencia a código, APIs o configuración que vive en un repositorio separado. -- Quieras que el agente compare tu contenido con el código fuente al decidir qué actualizar. -- El prompt del workflow se refiera a archivos fuera del repositorio de tu proyecto de Mintlify. - -Puedes añadir hasta 10 repositorios de contexto por workflow. - -
- ### Modo de actualización -
- -Decide cuánta revisión quieres antes de que los cambios se publiquen. - -- **Automático**: Los cambios se mergean directamente en el repositorio de tu proyecto de Mintlify sin revisión. Mejor para tareas de bajo riesgo y alta frecuencia como traducción, verificaciones gramaticales y reparación de enlaces. -- **Requiere revisión**: El agente abre una pull request y una persona la revisa antes de mergearla. Mejor para tareas que cambian el significado del contenido, como sincronizaciones con cambios de código o actualizaciones de referencias de API. - -
- ## Controlar el uso de créditos -
- -Cada ejecución de workflow consume créditos. Por ejemplo, la mayoría de las ejecuciones del workflow **actualizar desde cambios de código** cuestan entre 40 y 180 créditos. Las ejecuciones complejas que actualizan muchas páginas cuestan más. - -Programar trabajos cron para que se ejecuten en momentos concretos te permite controlar con mayor precisión el uso de créditos. Por ejemplo, puedes ejecutar un workflow una vez al día o una vez a la semana para saber exactamente cuántas pull requests crea un workflow al mes, en lugar de que dependa de cambios de contenido o de código que varían de un mes a otro. - -
- ## Revisar y mejorar los resultados de los workflows -
- -Los workflows se ejecutan automáticamente, pero se benefician de una revisión periódica. - -1. Abre la pestaña **Runs** en la página [Workflows](https://app.mintlify.com/products/workflows) para ver el historial de ejecuciones recientes y su estado. -2. Haz clic en una ejecución para leer el resumen del agente y revisar las pull requests que abrió. -3. Si los resultados son inconsistentes, refina tus instrucciones: añade procedimientos más específicos, reduce el alcance de los archivos o divide el workflow en tareas más pequeñas. - -Unos cuantos ciclos de revisión tras activar un nuevo workflow suelen ser suficientes para ajustar las instrucciones. diff --git a/es/organize/navigation.mdx b/es/organize/navigation.mdx index c8c0ff1f7..7d0d125f5 100644 --- a/es/organize/navigation.mdx +++ b/es/organize/navigation.mdx @@ -817,7 +817,7 @@ Actualmente ofrecemos compatibilidad con los siguientes idiomas para la localiza } ``` -Para traducciones automatizadas, [configura un workflow](/automations) para ejecutar el agente de forma programada o en respuesta a cambios enviados al repositorio. +Para traducciones automatizadas, [configura una automatización](/es/automations) para ejecutar el agente de forma programada o en respuesta a cambios enviados al repositorio.
diff --git a/es/what-is-mintlify.mdx b/es/what-is-mintlify.mdx index b3d007d98..7688e2961 100644 --- a/es/what-is-mintlify.mdx +++ b/es/what-is-mintlify.mdx @@ -43,7 +43,7 @@ Las funciones de IA integradas ayudan a las personas y a la IA a encontrar y com El **assistant** permite que tus usuarios hagan preguntas y obtengan respuestas citadas directamente de tu contenido. -El **agent** ayuda a tu equipo a crear y mantener contenido generando actualizaciones a partir de flujos de trabajo programados, solicitudes de extracción que se fusionan en tu repositorio de funcionalidades o hilos de Slack. +El **agent** ayuda a tu equipo a crear y mantener contenido generando actualizaciones a partir de automatizaciones programadas, solicitudes de extracción que se fusionan en tu repositorio de funcionalidades o hilos de Slack. Consulta [documentación nativa con IA](/es/ai-native) para ver una descripción general de todas las funciones de IA. diff --git a/es/workflows/create.mdx b/es/workflows/create.mdx deleted file mode 100644 index e80652ad3..000000000 --- a/es/workflows/create.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Crear un workflow personalizado" -description: "Crea un workflow personalizado de Mintlify con un trigger programado o de push, repositorios de contexto y un prompt para automatizar tareas recurrentes." -keywords: ["automatización", "automatizar", "cron", "agente", "workflow personalizado"] ---- - -import GitlabWorkflowSetup from '/snippets/es/gitlab-workflow-setup.mdx'; - -
- ## Requisitos previos -
- -- Un proyecto de Mintlify conectado a un repositorio de GitHub o GitLab -- Para GitHub: la [Mintlify GitHub App](/es/deploy/github) instalada en cada repositorio que planees usar en el workflow -- Para GitLab: una cuenta de GitLab conectada (consulta [Configuración de GitLab](#gitlab-setup) a continuación) - -
- ## Crear un workflow personalizado -
- - - El agente se ejecuta en un sandbox aislado con acceso restringido a internet. No puede instalar paquetes o herramientas adicionales en tiempo de ejecución. Los prompts que hacen referencia a herramientas no disponibles pueden producir resultados inesperados o fallar. - - -1. Abre la página [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) en tu panel. -2. Haz clic en **Create a custom workflow**. -3. Configura el nombre del workflow, el trigger, las instrucciones, los repositorios de contexto, las integraciones y el modo de actualización. -4. Haz clic en **Create workflow**. - -
- ## Escribir instrucciones efectivas -
- -Las instrucciones efectivas para workflows se centran en una sola tarea y definen un resultado claro y verificable. Los workflows presentan cierta variabilidad porque los agentes son no deterministas, pero las instrucciones bien formateadas producen resultados más consistentes. - -- **Describe el resultado.** Indica al agente cómo debe verse el resultado de una ejecución exitosa. -- **Escribe un procedimiento.** Dale al agente una guía paso a paso a seguir. -- **Mantén el alcance acotado.** Divide las tareas complejas en varios workflows en lugar de combinarlas en un solo prompt. - -Para más ejemplos y patrones, consulta [Usar workflows](/es/guides/use-workflows). - - - Revisa la salida de tus workflows personalizados para confirmar que funcionan como se espera. Actualiza tus instrucciones para mejorar los resultados. - - - - -
- ## Eliminar un workflow personalizado -
- -Eliminar un workflow es permanente y borra su configuración e historial de ejecuciones. - -1. Ve a la página [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) en tu panel. -2. Haz clic en el botón de configuración junto a un workflow. -3. Haz clic en **Delete**. diff --git a/es/workflows/index.mdx b/es/workflows/index.mdx deleted file mode 100644 index 1c86666a8..000000000 --- a/es/workflows/index.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Resumen de workflows" -sidebarTitle: "Resumen" -description: "Automatiza el mantenimiento de contenido con los workflows de Mintlify: ejecuta el agente según una programación o por pushes en GitHub y GitLab." -keywords: ["automatización", "automatizar", "cron", "agente", "workflows"] -boost: 5 ---- - -Los workflows ejecutan el agente automáticamente según una programación o en respuesta a cambios en un repositorio. Cada workflow define un prompt para el agente y un trigger que indica cuándo ejecutarlo. Los workflows admiten tanto repositorios de GitHub como de GitLab. - -Cuando se ejecuta un workflow, el agente lee el contenido de tu proyecto y los repositorios conectados, y luego sigue el prompt para realizar las actualizaciones. - - -Usa workflows que se ejecutan según una programación para tareas recurrentes, como publicar changelogs o auditar metadatos de SEO. - -Usa workflows que se activan por cambios de contenido o de código para tareas de mantenimiento reactivas, como traducciones o actualizaciones de contenido cuando cambia el código fuente. - - -
- ## Tipos de trigger -
- -Los workflows admiten tres tipos de trigger. - -- **Actualización de contenido**—Se ejecuta cuando se hace push de cambios de contenido a tu repositorio de proyecto de Mintlify, incluidos los merges de pull requests y los pushes directos. -- **Cambio de código**—Se ejecuta cuando se mergea una pull request en un repositorio de código fuente conectado. -- **Programación personalizada**—Se ejecuta según una programación recurrente. Los workflows se ponen en cola en un plazo de 10 minutos a partir de la hora programada. - -Cada workflow tiene exactamente un trigger. No puedes combinar tipos de trigger en un solo workflow. - -
- ## Límites de uso -
- -Las ejecuciones de workflows cuentan para tu uso de créditos. Consulta tu uso de créditos, configura excedentes y gestiona tu paquete de créditos en la página [Uso](https://app.mintlify.com/settings/organization/usage) de tu panel. - -Cada workflow puede ejecutarse hasta 500 veces al día. Las ejecuciones fallidas no cuentan para este límite. - -
- ## Próximos pasos -
- - - - Referencia de todos los workflows predefinidos: triggers, modos de actualización y configuración requerida. - - - Activa workflows predefinidos y configura triggers, modo de actualización y contexto. - - - Crea un workflow con tu propio trigger, instrucciones y repositorios de contexto. - - - Elige el trigger adecuado, escribe instrucciones efectivas y revisa los resultados. - - diff --git a/es/workflows/manage.mdx b/es/workflows/manage.mdx deleted file mode 100644 index c71ec5efa..000000000 --- a/es/workflows/manage.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Gestionar workflows" -description: "Activa, desactiva, ejecuta y elimina workflows desde tu panel. Configura triggers de GitHub o GitLab, programaciones, repos de contexto y automerge." -keywords: ["cron", "push", "automerge", "contexto", "instrucciones de workflow", "trigger", "desactivar workflow", "activar workflow"] ---- - -import GitlabWorkflowSetup from '/snippets/es/gitlab-workflow-setup.mdx'; - -
- ## Requisitos previos -
- -- Un proyecto de Mintlify conectado a un repositorio de GitHub o GitLab -- Para GitHub: la [Mintlify GitHub App](/es/deploy/github) instalada en cada repositorio que planees usar en el workflow -- Para GitLab: una cuenta de GitLab conectada (consulta [Configuración de GitLab](#gitlab-setup) a continuación) - - - También puedes crear, listar y eliminar workflows desde la terminal con [`mint workflow`](/es/cli/commands#mint-workflow). La CLI es útil para scripting y CI; el panel es la forma más sencilla de configurar y monitorear las ejecuciones de los workflows. - - -
- ## Activar un workflow -
- -1. Abre la página [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) en tu panel. -2. Haz clic en el interruptor junto a un workflow para activarlo. - - El panel de workflows. - El panel de workflows. - - - Si el workflow puede ejecutarse con la configuración predeterminada, se activa de inmediato. De lo contrario, se abre el panel de configuración para que completes cualquier configuración requerida. - - Las opciones de configuración de un workflow. - Las opciones de configuración de un workflow. - -3. Si se abre el panel de configuración, completa los campos requeridos. -4. Haz clic en **Turn on workflow**. - -Para cambiar la configuración de un workflow activo, haz clic en el botón de configuración junto a él. Usa el interruptor en el encabezado del modal para activar o desactivar el workflow sin salir de la vista de configuración. - -
- ## Configuraciones -
- -
- ### Trigger -
- -Cada workflow tiene un trigger por defecto que controla cuándo se ejecuta. Para cambiar el trigger, selecciona una opción diferente en el panel de configuración. - -- **Actualización de contenido**—Se ejecuta cuando haces push de contenido a tu repositorio de proyecto, incluidos los merges de pull requests y los pushes directos. -- **Cambio de código**—Se ejecuta cuando se mergea una pull request en un repositorio de código fuente conectado. Debes especificar al menos un repositorio de origen. -- **Programación personalizada**—Se ejecuta según una programación recurrente que definas. Los workflows se ponen en cola en un plazo de 10 minutos a partir de la hora programada. - -
- ### Modo de actualización -
- -Cada workflow tiene un modo predeterminado para cómo realiza las actualizaciones. Ya sea mergeando los cambios directamente en tu repositorio de contenido o abriendo una pull request para su revisión. - -Para requerir una revisión antes de que el workflow actualice tu contenido, selecciona **Require review** en el panel de configuración. - - - Para repositorios de GitHub, las actualizaciones automáticas requieren que la Mintlify GitHub App tenga permisos de bypass en cada ruleset que apunte a tu rama de despliegue, incluidos los rulesets a nivel de organización y a nivel de repositorio. Consulta [Configurar automerge](/es/guides/configure-automerge) para las instrucciones de configuración. - - Para repositorios de GitLab, automerge utiliza la conexión OAuth de GitLab y requiere al menos el rol de Maintainer en cada proyecto. - - -
- ### Repositorios de contexto -
- -Para workflows personalizados y algunos workflows predefinidos, puedes añadir repositorios de contexto: repositorios de código fuente adicionales que el agente lee cuando se ejecuta el workflow. Esto es útil cuando el prompt de tu workflow hace referencia a código, APIs u otro contenido que vive fuera del repositorio de tu proyecto. - -Puedes añadir hasta 10 repositorios de contexto por workflow. Para cada repositorio de GitHub, la Mintlify GitHub App debe estar instalada. Añade repositorios en la página [Configuración de GitHub App](https://app.mintlify.com/settings/organization/github-app). - -
- ### Integraciones -
- -Para los workflows personalizados y el workflow **Update from code changes**, puedes habilitar [integraciones del agente](/es/agent/integrations) conectadas para que el agente pueda obtener contexto desde herramientas como Slack, Notion o Linear cuando se ejecute el workflow. - -Para habilitar integraciones en un workflow, abre su configuración y selecciona las integraciones que quieres que el agente use en la sección **Available integrations**. Solo aparecerán en la lista las integraciones ya conectadas para tu organización. Consulta [Integraciones del agente](/es/agent/integrations) para más información sobre cómo conectar integraciones. - -
- ### Notificaciones de Slack -
- -Envía mensajes de Slack a los canales seleccionados cuando se ejecuten los workflows. Usa las notificaciones de Slack para mantener a tu equipo al tanto de la actividad de los workflows en curso sin tener que vigilar el dashboard. - -Para habilitar las notificaciones de Slack, instala la [aplicación de Slack de Mintlify](/es/agent/slack) en tu workspace y, a continuación, añade uno o más canales de notificación en la sección **Notification channels** de la configuración de tu workflow. - -Una vez habilitadas, Mintlify publica en los canales configurados cuando: - -- Un workflow abre una pull request para revisión. -- Una pull request abierta por un workflow lleva esperando revisión **3 días** sin haberse fusionado. Mintlify envía un recordatorio diario hasta que la pull request se fusione o se cierre. Cuando la pull request se resuelve, el recordatorio original se actualiza con un tachado para que las alertas obsoletas no permanezcan visibles. -- Un workflow fusiona una pull request o no logra completarse. - -Los recordatorios de revisiones obsoletas se aplican a cualquier workflow configurado para abrir pull requests para revisión (consulta [Modo de actualización](#update-mode)). Solo se activan cuando hay canales de notificación de Slack configurados para el workflow. - -
- ### Instrucciones -
- -Añade instrucciones opcionales que se adjuntan al prompt base del workflow en cada ejecución. Úsalas para ajustar el estilo, el tono u otros comportamientos específicos del proyecto sin cambiar la lógica principal del workflow. - -
- ### Idiomas de destino -
- -Cuando activas el workflow **traducir contenido**, selecciona uno o más idiomas para mantenerlos sincronizados con tu contenido fuente. - -- Mintlify lee los [idiomas](/es/organize/navigation#languages) definidos en tu `docs.json` para identificar tu idioma predeterminado y preselecciona los idiomas de destino ya configurados. -- Debes seleccionar al menos un idioma de destino para guardar el workflow. -- No puedes seleccionar el idioma fuente como destino. - -Puedes añadir idiomas de destino en cualquier momento abriendo la configuración del workflow y editando el campo **Translate to**. - - - -
- ## Desactivar un workflow -
- -1. Ve a la página [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) en tu panel. -2. Haz clic en el interruptor junto a un workflow para desactivarlo. - -Cuando reactivas un workflow programado, Mintlify recalcula la próxima hora de ejecución a partir de la hora actual. - -
- ## Ver el historial de ejecuciones -
- -Cada workflow mantiene un registro de ejecuciones pasadas, incluido el estado y un resumen de los cambios realizados. - -1. Ve a la página [Workflow Runs](https://app.mintlify.com/products/workflows) en tu panel. -2. Usa los menús desplegables para filtrar por workflows específicos o por estado. - - Página de ejecuciones de workflows mostrando los filtros de workflow y estado. - Página de ejecuciones de workflows mostrando los filtros de workflow y estado. - diff --git a/es/workflows/reference.mdx b/es/workflows/reference.mdx deleted file mode 100644 index f2b515ddd..000000000 --- a/es/workflows/reference.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Workflows predefinidos" -description: "Referencia de los workflows predefinidos de Mintlify: trigger por defecto, modo de actualización, soporte de repositorios de contexto y configuración." -keywords: ["predefinido", "automatización", "por defecto"] ---- - -Mintlify incluye workflows predefinidos para las tareas de mantenimiento de documentación más comunes. Cada workflow tiene un prompt base y una configuración por defecto. Puedes personalizar el trigger, el modo de actualización y las instrucciones desde la página [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) en tu panel. - -
- ## Workflows de contenido autoactualizable -
- -Los workflows de contenido autoactualizable realizan actualizaciones basadas en el contexto que defines, de modo que tu contenido se mantenga preciso y al día. - -
- ### Actualizar desde cambios de código -
- -Monitorea tus repositorios de código fuente y abre pull requests para actualizar el contenido cuando se produzcan cambios que afecten a los usuarios. Puedes ejecutar este workflow según una programación, lo que generalmente consume menos créditos, o en cada pull request de código fuente. Por defecto, este workflow se ejecuta dos veces por semana (martes y jueves). Los demás workflows programados siguen ejecutándose con una programación semanal por defecto. - -Cuando ejecutas el workflow según una programación, el agente lee todas las pull requests de código fuente mergeadas desde la última vez que se ejecutó el workflow. Agrupa los cambios relacionados que requieren actualizaciones de contenido en una pull request en tu repositorio de proyecto de Mintlify. Si hay pull requests sin mergear de ejecuciones anteriores, el agente añade los cambios relevantes a las pull requests existentes. El agente cita la procedencia de los cambios en tus repositorios de código fuente. - -Cuando ejecutas el workflow en cada pull request de código fuente, el agente crea una pull request de actualización de contenido cada vez que mergeas una pull request de código fuente que requiere actualizaciones de contenido. Usa la variante basada en push cuando quieras que las actualizaciones de contenido aparezcan tan pronto como se publique el código, en lugar de agruparlas según una programación. - -Puedes habilitar [integraciones del agente](/es/agent/integrations) para este workflow para dar al agente contexto adicional desde herramientas como Slack o Linear al determinar qué actualizar. - -
- ### Borrador de changelog -
- -Crea una entrada de changelog según una programación recurrente. Añade repositorios de código fuente como contexto para que el agente tenga más detalles sobre cómo cambió tu producto. Sin repositorios de contexto, el agente trabaja a partir de tus actualizaciones de contenido para escribir una entrada de changelog. - -
- ### Borrador de mejoras a partir de conversaciones del asistente -
- -Revisa las tendencias de preguntas de tu [asistente](/es/assistant/index) para identificar lagunas en tu contenido, y luego abre una pull request para abordarlas. Cuantas más conversaciones del asistente tengan tus usuarios, más señal tendrá el agente para trabajar. Ejecuta este workflow según una programación recurrente para mantener el contenido alineado con lo que los usuarios quieren saber sobre tu producto. - -
- ### Borrador de mejoras a partir de comentarios de usuarios -
- -Revisa los [comentarios](/es/optimize/feedback) de las páginas — valoraciones con pulgar arriba/abajo y comentarios escritos — y actualiza el contenido en las páginas donde los usuarios han reportado problemas. El agente se centra en las páginas con señales negativas recurrentes en lugar de en comentarios aislados, por lo que los resultados mejoran a medida que se acumulan los comentarios. - -Debes habilitar la recopilación de comentarios en la página [Complementos](https://app.mintlify.com/products/addons) antes de poder usar este workflow. - -
- ## Workflows de mantenimiento -
- -Los workflows de mantenimiento automatizan tareas rutinarias para mejorar la calidad y la consistencia de tu contenido. Puedes ejecutarlos con un trigger de actualización de contenido o según una programación recurrente. - -Ejecutarlos con un trigger de actualización de contenido mantiene tu contenido con un retraso mínimo. Ejecutarlos según una programación suele ser más eficiente en créditos, ya que el agente agrupa el trabajo de varios cambios en una sola ejecución, pero hay un retraso entre el momento en que cambia el contenido y el momento en que el workflow de mantenimiento actúa sobre él. - -Cualquier workflow de mantenimiento habilitado se ejecuta en las pull requests creadas por workflows de contenido autoactualizable. Si el workflow de mantenimiento requiere cambios, el agente combina el trabajo en una sola pull request. Por ejemplo, si habilitas el workflow **traducir contenido**, el agente añade traducciones a las pull requests abiertas por el workflow **actualizar desde cambios de código**. - -
- ### Traducir contenido -
- -Traduce el contenido actualizado a los idiomas de destino que selecciones cada vez que se hagan push de cambios a tu repositorio de proyecto. Debes especificar al menos un idioma de destino. Mintlify lee los [idiomas](/es/organize/navigation#languages) definidos en tu `docs.json` y preselecciona los idiomas de destino ya configurados. - -Para deshabilitar las traducciones de un idioma, elimina todos los archivos en el directorio de ese idioma. No puedes deshabilitar las traducciones de un idioma que todavía tiene contenido publicado. - - - -Encuentra y repara enlaces internos y externos rotos cada vez que se hagan push de cambios de contenido a tu repositorio de proyecto. Es útil ejecutarlo después de reorganizaciones importantes de contenido o cuando los servicios externos a los que haces referencia cambian sus URLs. - -
- ### Auditar metadatos de SEO -
- -Audita y actualiza los títulos, las meta descripciones, los encabezados y las etiquetas canónicas cada vez que cambie el contenido. Añade instrucciones para alinear las sugerencias del agente con tu estrategia de SEO o con palabras clave objetivo. - -
- ### Corregir gramática y erratas -
- -Encuentra y corrige erratas, errores ortográficos y errores gramaticales cada vez que cambie el contenido. Añade instrucciones para especificar excepciones para términos técnicos, nombres de productos o decisiones estilísticas intencionales que el agente no deba cambiar. - -
- ### Aplicar guía de estilo -
- -Aplica reglas de voz, tono y escritura al contenido cada vez que cambia. Añade instrucciones para definir las reglas específicas que quieres que se apliquen o enlaza tu guía de estilo. Cuanto más precisas sean tus instrucciones, más consistentes serán los resultados. diff --git a/fr.json b/fr.json index 094bb7621..5bca6f980 100644 --- a/fr.json +++ b/fr.json @@ -91,6 +91,15 @@ "fr/agent/workflows" ] }, + { + "group": "Automatisations", + "pages": [ + "fr/automations/index", + "fr/automations/reference", + "fr/automations/manage", + "fr/automations/create" + ] + }, { "group": "Composants", "pages": [ @@ -277,7 +286,7 @@ "pages": [ "fr/guides/assistant-embed", "fr/guides/configure-automerge", - "fr/guides/use-workflows", + "fr/guides/use-automations", "fr/guides/claude-code", "fr/guides/cursor", "fr/guides/geo", diff --git a/fr/agent/index.mdx b/fr/agent/index.mdx index 83b65cf69..ed61f9a40 100644 --- a/fr/agent/index.mdx +++ b/fr/agent/index.mdx @@ -26,7 +26,7 @@ Utilisez l’agent pour : * Rechercher et réviser des exemples de code et des références d’API dans l’ensemble de votre documentation. * Référencer le code source de n’importe quel dépôt sur lequel la GitHub App Mintlify est installée. * Récupérer du contexte en direct depuis des applications connectées comme Slack, Notion, Linear et Jira. -* Automatiser la maintenance de la documentation avec des workflows. +* Automatiser la maintenance de la documentation avec des automatisations. * 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. @@ -82,6 +82,6 @@ Ajoutez ensuite le serveur MCP Mintlify pour accéder au dashboard et à d'autre Obtenez de meilleurs résultats grâce à des prompts ciblés. - - Automatisez les tâches récurrentes et la maintenance de la documentation à l'aide de workflows. + + Automatisez les tâches récurrentes et la maintenance de la documentation à l'aide d'automatisations. \ No newline at end of file diff --git a/fr/agent/use-cases.mdx b/fr/agent/use-cases.mdx index ed8c34b0f..b4d8842d0 100644 --- a/fr/agent/use-cases.mdx +++ b/fr/agent/use-cases.mdx @@ -1,7 +1,7 @@ --- title: "Cas d’usage" description: "Explorez des exemples concrets d'utilisation de l'agent Mintlify pour automatiser les mises à jour, capturer le savoir et maintenir une doc précise." -keywords: ["workflows de l'agent", "workflows de documentation", "exemples d'automatisation"] +keywords: ["agent automations", "documentation automations", "automation examples"] --- L’agent vous aide dans de nombreuses tâches liées à la documentation. Ces exemples illustrent plusieurs façons d’intégrer l’agent à votre processus de documentation. Essayez une approche qui corresponde à la façon dont votre équipe travaille aujourd’hui, puis adaptez-la à vos besoins spécifiques. @@ -78,13 +78,13 @@ Soumettez à l’agent les retours de vos utilisateurs pour apporter des mises Par exemple : `@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. -
- ## Automatiser avec des workflows +
+ ## Automatiser avec des automatisations
-Créez des workflows pour automatiser les tâches récurrentes et les tâches de maintenance réactive, comme la rédaction de journaux des modifications ou la mise à jour du contenu lorsque vous ajoutez de nouvelles fonctionnalités à votre produit. +Créez des automatisations pour automatiser les tâches récurrentes et les tâches de maintenance réactive, comme la rédaction de journaux des modifications ou la mise à jour du contenu lorsque vous ajoutez de nouvelles fonctionnalités à votre produit. -Consultez [Vue d'ensemble des workflows](/fr/workflows/index) pour plus d'informations. +Consultez [Vue d'ensemble des automatisations](/fr/automations/index) pour plus d'informations.
## Automatiser avec l'API diff --git a/fr/ai-native.mdx b/fr/ai-native.mdx index dc2606b13..e82c073d5 100644 --- a/fr/ai-native.mdx +++ b/fr/ai-native.mdx @@ -23,7 +23,7 @@ En plus de consulter des pages individuelles, les utilisateurs peuvent échanger L’[agent](/fr/agent) vous aide à rédiger et à maintenir votre documentation. Il crée des pull requests (demandes de fusion) avec des modifications proposées à partir de vos instructions, de pull requests et de fils Slack. Ajoutez l’agent à votre espace de travail Slack pour que chacun dans votre équipe puisse contribuer à la maintenance de votre documentation en discutant avec lui. Ou intégrez l’agent à des applications personnalisées via l’[API](/fr/api/agent/v2/create-agent-job). -Créez des [workflows](/automations/index) pour exécuter l’agent selon une planification ou lors d’un `push` vers un référentiel. Chaque workflow définit une instruction (prompt) pour l’agent et un déclencheur indiquant quand l’exécuter. +Créez des [automatisations](/fr/automations/index) pour exécuter l’agent selon une planification ou lors d’un `push` vers un référentiel. Chaque automatisation définit une instruction (prompt) pour l’agent et un déclencheur indiquant quand l’exécuter. Configurez des outils populaires comme [Cursor](/fr/guides/cursor), [Claude Code](/fr/guides/claude-code) et [Windsurf](/fr/guides/windsurf) pour s’appuyer sur le schéma Mintlify, votre guide de style et les bonnes pratiques. @@ -60,7 +60,7 @@ Sélectionnez l’une des cartes suivantes pour en savoir plus. Configurez l’Assistant pour rechercher sur des sites externes ou orienter les utilisateurs vers votre équipe d’assistance s’il ne peut pas répondre à leurs questions. - + Recevez automatiquement des mises à jour de la documentation selon une planification définie ou lorsqu’un événement de push se produit. diff --git a/fr/assistant/index.mdx b/fr/assistant/index.mdx index 8e511228e..ef0e9ccbd 100644 --- a/fr/assistant/index.mdx +++ b/fr/assistant/index.mdx @@ -6,7 +6,7 @@ boost: 3 --- - L'assistant est activé par défaut. Les organisations Hobby reçoivent 5 000 crédits d'essai partagés entre l'assistant, les agents et les workflows. [Achetez le forfait de crédits](/fr/credits#credit-bundle) pour continuer après l'essai. + L'assistant est activé par défaut. Les organisations Hobby reçoivent 5 000 crédits d'essai partagés entre l'assistant, les agents et les automatisations. [Achetez le forfait de crédits](/fr/credits#credit-bundle) pour continuer après l'essai.
diff --git a/fr/automations/create.mdx b/fr/automations/create.mdx new file mode 100644 index 000000000..d94c90c4e --- /dev/null +++ b/fr/automations/create.mdx @@ -0,0 +1,56 @@ +--- +title: "Créer une automatisation personnalisée" +description: "Créez une automatisation Mintlify personnalisée avec un déclencheur de calendrier ou de push, des dépôts de contexte et un prompt d'agent pour automatiser les tâches de documentation récurrentes." +keywords: ["automation", "automate", "cron", "agent", "custom automation"] +--- + +import GitlabAutomationSetup from '/snippets/fr/gitlab-automation-setup.mdx'; + +
+ ## Prérequis +
+ +- Un projet Mintlify connecté à un dépôt GitHub ou GitLab +- Pour GitHub : la [GitHub App Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans l'automatisation +- Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous) + +
+ ## Créer une automatisation personnalisée +
+ + + L'agent s'exécute dans un sandbox isolé avec un accès Internet restreint. Il ne peut pas installer de packages ou d'outils supplémentaires à l'exécution. Les prompts qui font référence à des outils indisponibles peuvent produire des résultats inattendus ou échouer. + + +1. Ouvrez la page [Automations](https://app.mintlify.com/products/automations) dans votre dashboard. +2. Cliquez sur **Create a custom automation**. +3. Configurez le nom de l'automatisation, le déclencheur, les instructions, les dépôts de contexte, les intégrations et le mode de mise à jour. +4. Cliquez sur **Create automation**. + +
+ ## Rédiger des instructions efficaces +
+ +Des instructions d'automatisation efficaces se concentrent sur une seule tâche et définissent un résultat clair et vérifiable. Les automatisations présentent une certaine variabilité car les agents sont non déterministes, mais des instructions bien formulées produisent des résultats plus cohérents. + +- **Décrivez le résultat.** Indiquez à l'agent à quoi devrait ressembler une exécution réussie. +- **Rédigez une procédure.** Donnez à l'agent un guide étape par étape à suivre. +- **Restez précis dans la portée.** Divisez les tâches complexes en plusieurs automatisations plutôt que de les combiner dans un seul prompt. + +Pour plus d'exemples et de modèles, consultez [Utiliser les automatisations](/fr/guides/use-automations). + + + Vérifiez les résultats de vos automatisations personnalisées pour confirmer qu'elles fonctionnent comme prévu. Mettez à jour vos instructions pour améliorer les résultats. + + + + +
+ ## Supprimer une automatisation personnalisée +
+ +La suppression d'une automatisation est définitive et supprime sa configuration ainsi que l'historique de ses exécutions. + +1. Accédez à la page [Automations](https://app.mintlify.com/products/automations) dans votre dashboard. +2. Cliquez sur le bouton de paramètres à côté d'une automatisation. +3. Cliquez sur **Delete**. diff --git a/fr/automations/index.mdx b/fr/automations/index.mdx new file mode 100644 index 000000000..2ebb81e48 --- /dev/null +++ b/fr/automations/index.mdx @@ -0,0 +1,56 @@ +--- +title: "Vue d'ensemble des automatisations" +sidebarTitle: "Vue d'ensemble" +description: "Automatisez la maintenance du contenu avec les automatisations Mintlify. Exécutez l'agent selon un calendrier ou en réponse à des pushes sur des dépôts GitHub et GitLab." +keywords: ["automation", "automate", "cron", "agent", "automations"] +boost: 5 +--- + +Les automatisations exécutent l'agent automatiquement selon un calendrier ou en réponse à des modifications dans un dépôt. Chaque automatisation définit un prompt pour l'agent et un déclencheur indiquant quand l'exécuter. Les automatisations prennent en charge les dépôts GitHub et GitLab. + +Lorsqu'une automatisation s'exécute, l'agent lit le contenu de votre projet et tout dépôt connecté, puis suit le prompt pour effectuer les mises à jour. + + +Utilisez des automatisations planifiées pour les tâches récurrentes, comme la publication de changelogs ou l'audit des métadonnées SEO. + +Utilisez des automatisations déclenchées par des modifications de contenu ou de code pour la maintenance réactive, comme les traductions ou la mise à jour du contenu lorsque le code source change. + + +
+ ## Types de déclencheurs +
+ +Les automatisations prennent en charge trois types de déclencheurs. + +- **Mise à jour de contenu** : s'exécute lorsque des modifications de contenu sont poussées vers le dépôt de votre projet Mintlify, y compris les fusions de pull requests et les pushes directs. +- **Modification de code** : s'exécute lorsqu'une pull request est fusionnée dans un dépôt de code source connecté. +- **Calendrier personnalisé** : s'exécute selon un calendrier récurrent. Les automatisations sont mises en file d'attente dans les 10 minutes suivant l'heure planifiée. + +Chaque automatisation possède exactement un déclencheur. Vous ne pouvez pas combiner plusieurs types de déclencheurs dans une seule automatisation. + +
+ ## Limites d'utilisation +
+ +Les exécutions d'automatisations sont décomptées de votre utilisation de crédits. Consultez votre utilisation de crédits, configurez les dépassements et gérez votre package de crédits sur la page [Usage](https://app.mintlify.com/settings/organization/usage) de votre dashboard. + +Chaque automatisation peut s'exécuter jusqu'à 500 fois par jour. Les exécutions qui échouent ne comptent pas dans cette limite. + +
+ ## Prochaines étapes +
+ + + + Référence pour toutes les automatisations prédéfinies : déclencheurs, modes de mise à jour et configuration requise. + + + Activez les automatisations prédéfinies et configurez les déclencheurs, le mode de mise à jour et le contexte. + + + Créez une automatisation avec votre propre déclencheur, des instructions et des dépôts de contexte. + + + Choisissez le bon déclencheur, rédigez des instructions efficaces et passez en revue les résultats. + + diff --git a/fr/automations/manage.mdx b/fr/automations/manage.mdx new file mode 100644 index 000000000..9615fbbd0 --- /dev/null +++ b/fr/automations/manage.mdx @@ -0,0 +1,148 @@ +--- +title: "Gérer les automatisations" +description: "Activez, désactivez, déclenchez et supprimez des automatisations depuis votre dashboard. Configurez des déclencheurs GitHub ou GitLab, des calendriers, des dépôts de contexte et l'automerge." +keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"] +--- + +import GitlabAutomationSetup from '/snippets/fr/gitlab-automation-setup.mdx'; + +
+ ## Prérequis +
+ +- Un projet Mintlify connecté à un dépôt GitHub ou GitLab +- Pour GitHub : la [GitHub App Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans l'automatisation +- Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous) + + + Vous pouvez également créer, lister et supprimer des automatisations depuis le terminal avec [`mint automation`](/fr/cli/commands#mint-automation). La CLI est utile pour les scripts et la CI ; le dashboard est le moyen le plus simple de configurer et de surveiller les exécutions d'automatisations. + + +
+ ## Activer une automatisation +
+ +1. Ouvrez la page [Automations](https://app.mintlify.com/products/automations) dans votre dashboard. +2. Cliquez sur le bouton bascule à côté d'une automatisation pour l'activer. + + Le dashboard des automatisations. + Le dashboard des automatisations. + + + Si l'automatisation peut s'exécuter avec les paramètres par défaut, elle s'active immédiatement. Sinon, le panneau de paramètres s'ouvre pour vous permettre de remplir les configurations requises. + + Les options de configuration d'une automatisation. + Les options de configuration d'une automatisation. + +3. Si le panneau de paramètres s'ouvre, remplissez les champs requis. +4. Cliquez sur **Turn on automation**. + +Pour modifier les paramètres d'une automatisation active, cliquez sur le bouton de paramètres à côté de celle-ci. Utilisez le bouton bascule dans l'en-tête de la modale pour activer ou désactiver l'automatisation sans quitter la vue des paramètres. + +
+ ## Configurations +
+ +
+ ### Déclencheur +
+ +Chaque automatisation possède un déclencheur par défaut qui contrôle son moment d'exécution. Pour changer le déclencheur, sélectionnez une autre option dans le panneau des paramètres. + +- **Mise à jour de contenu** : s'exécute chaque fois que vous poussez du contenu vers le dépôt de votre projet, y compris les fusions de pull requests et les pushes directs. +- **Modification de code** : s'exécute lorsqu'une pull request est fusionnée dans un dépôt de code source connecté. Vous devez spécifier au moins un dépôt source. +- **Calendrier personnalisé** : s'exécute selon un calendrier récurrent que vous définissez. Les automatisations sont mises en file d'attente dans les 10 minutes suivant l'heure planifiée. + +
+ ### Mode de mise à jour +
+ +Chaque automatisation possède un mode par défaut pour effectuer les mises à jour. Soit fusionner directement les modifications dans votre dépôt de contenu, soit ouvrir une pull request pour relecture. + +Pour exiger une relecture avant que l'automatisation ne mette à jour votre contenu, sélectionnez **Require review** dans le panneau des paramètres. + + + Pour les dépôts GitHub, les mises à jour automatiques nécessitent que la GitHub App Mintlify dispose d'autorisations de contournement (bypass) sur chaque ensemble de règles ciblant votre branche de déploiement, y compris les ensembles de règles au niveau de l'organisation et du dépôt. Consultez [Configurer l'automerge](/fr/guides/configure-automerge) pour les instructions d'installation. + + Pour les dépôts GitLab, l'automerge utilise la connexion OAuth GitLab et nécessite au moins le rôle Maintainer sur chaque projet. + + +
+ ### Dépôts de contexte +
+ +Pour les automatisations personnalisées et certaines automatisations prédéfinies, vous pouvez ajouter des dépôts de contexte — des dépôts de code source supplémentaires que l'agent lit lorsque l'automatisation s'exécute. C'est utile lorsque le prompt de votre automatisation fait référence à du code, des API ou d'autres contenus qui se trouvent en dehors de votre dépôt de projet. + +Vous pouvez ajouter jusqu'à 10 dépôts de contexte par automatisation. Pour chaque dépôt GitHub, installez la GitHub App Mintlify. Ajoutez des dépôts sur la page [GitHub App settings](https://app.mintlify.com/settings/organization/github-app). + +
+ ### Intégrations +
+ +Pour les automatisations personnalisées et l'automatisation **Update from code changes**, vous pouvez activer les [intégrations de l'agent](/fr/agent/integrations) connectées afin que l'agent puisse récupérer du contexte depuis des outils comme Slack, Notion ou Linear lorsque l'automatisation s'exécute. + +Pour activer les intégrations d'une automatisation, ouvrez ses paramètres et sélectionnez les intégrations que vous souhaitez que l'agent utilise dans la section **Available integrations**. Seules les intégrations déjà connectées pour votre organisation apparaissent dans la liste. Consultez [Intégrations de l'agent](/fr/agent/integrations) pour plus d'informations sur la connexion des intégrations. + +
+ ### Notifications Slack +
+ +Envoyez des messages Slack à un ou plusieurs canaux lorsque les automatisations s'exécutent. + +Pour activer les notifications Slack : +1. Installez l'[application Slack Mintlify](/fr/agent/slack) dans votre espace de travail. +2. Cliquez sur **Turn on Slack notifications** sur la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. + + Le bouton d'activation des notifications Slack. + Le bouton d'activation des notifications Slack. + +3. Sélectionnez un ou plusieurs canaux de notification. +4. Cliquez sur **Save changes**. + +Une fois activé, Mintlify publie dans les canaux sélectionnés lorsque : + +- Une automatisation ouvre une pull request pour relecture. +- Une pull request d'automatisation attend une relecture depuis trois jours. +- Une automatisation fusionne une pull request, ou échoue à se terminer. + +
+ ### Instructions +
+ +Ajoutez des instructions facultatives qui s'ajoutent au prompt de base de l'automatisation à chaque exécution. Utilisez-les pour ajuster le style, le ton ou d'autres comportements spécifiques au projet sans modifier la logique principale de l'automatisation. + +
+ ### Langues cibles +
+ +Lorsque vous activez l'automatisation **Translate content**, sélectionnez une ou plusieurs langues à maintenir en synchronisation avec votre contenu source. + +- Mintlify lit les [langues](/fr/organize/navigation#languages) définies dans votre `docs.json` pour identifier votre langue par défaut et présélectionne les langues cibles déjà configurées. +- Vous devez sélectionner au moins une langue cible pour enregistrer l'automatisation. +- Vous ne pouvez pas sélectionner la langue source comme cible. + +Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres de l'automatisation et en modifiant le champ **Translate to**. + + + +
+ ## Désactiver une automatisation +
+ +1. Accédez à la page [Automations](https://app.mintlify.com/products/automations) dans votre dashboard. +2. Cliquez sur le bouton bascule à côté d'une automatisation pour la désactiver. + +Lorsque vous réactivez une automatisation planifiée ou modifiez son calendrier, Mintlify recalcule la prochaine heure d'exécution à partir de l'heure actuelle. Les automatisations désactivées ne conservent pas d'heure d'exécution en attente. + +
+ ## Consulter l'historique des exécutions +
+ +Chaque automatisation conserve un journal des exécutions passées, incluant le statut et un résumé des modifications effectuées. + +1. Accédez à la page [Automation Runs](https://app.mintlify.com/products/automations) dans votre dashboard. +2. Utilisez les menus déroulants pour filtrer par automatisations spécifiques ou par statut. + + Page des exécutions d'automatisations montrant les filtres par automatisation et par statut. + Page des exécutions d'automatisations montrant les filtres par automatisation et par statut. + diff --git a/fr/automations/reference.mdx b/fr/automations/reference.mdx new file mode 100644 index 000000000..a3375f3f0 --- /dev/null +++ b/fr/automations/reference.mdx @@ -0,0 +1,87 @@ +--- +title: "Automatisations prédéfinies" +description: "Référence pour toutes les automatisations Mintlify prédéfinies, y compris le déclencheur par défaut, le mode de mise à jour, la prise en charge des dépôts de contexte et les configurations requises." +keywords: ["predefined", "automation", "default"] +--- + +Mintlify inclut des automatisations prédéfinies pour les tâches de maintenance de documentation les plus courantes. Chaque automatisation possède un prompt de base et une configuration par défaut. Vous pouvez personnaliser le déclencheur, le mode de mise à jour et les instructions depuis la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. + +
+ ## Automatisations de contenu auto-mis à jour +
+ +Les automatisations de contenu auto-mis à jour effectuent des mises à jour à partir d'un contexte que vous définissez afin que votre contenu reste précis et à jour. + +
+ ### Mettre à jour à partir des modifications de code +
+ +Surveille vos dépôts de code source et ouvre des pull requests pour mettre à jour le contenu en cas de modifications affectant les utilisateurs. Vous pouvez exécuter cette automatisation selon un calendrier, ce qui consomme généralement moins de crédits, ou à chaque pull request de code source. Par défaut, cette automatisation s'exécute deux fois par semaine (mardi et jeudi). + +Lorsque vous exécutez l'automatisation selon un calendrier, l'agent lit toutes les pull requests de code source fusionnées depuis la dernière exécution. Il regroupe les modifications associées nécessitant des mises à jour de contenu dans une pull request sur le dépôt de votre projet Mintlify. S'il existe des pull requests non fusionnées provenant d'exécutions précédentes, l'agent ajoute les modifications pertinentes aux pull requests existantes. L'agent indique d'où proviennent les modifications dans vos dépôts de code source. + +Lorsque vous exécutez l'automatisation à chaque pull request de code source, l'agent ouvre une pull request de mise à jour de contenu chaque fois que vous fusionnez un changement de code nécessitant des mises à jour de contenu. Utilisez la variante basée sur les pushes lorsque vous souhaitez que les mises à jour de contenu apparaissent dès que le code est livré, plutôt que groupées selon un calendrier. + +Vous pouvez activer les [intégrations de l'agent](/fr/agent/integrations) pour cette automatisation afin de fournir à l'agent un contexte supplémentaire provenant d'outils comme Slack ou Linear lors de la détermination des éléments à mettre à jour. + +
+ ### Brouillon de changelog +
+ +Crée une entrée de changelog selon un calendrier récurrent. Ajoutez des dépôts de code source comme contexte pour que l'agent dispose de plus de détails sur l'évolution de votre produit. Sans dépôts de contexte, l'agent se base sur vos mises à jour de contenu pour rédiger une entrée de changelog. + +
+ ### Brouillon d'améliorations à partir des conversations de l'assistant +
+ +Examine les tendances de questions issues de votre [assistant](/fr/assistant/index) pour identifier les lacunes de votre contenu, puis ouvre une pull request pour y remédier. Plus vos utilisateurs ont de conversations avec l'assistant, plus l'agent dispose de signaux à exploiter. Exécutez cette automatisation selon un calendrier récurrent pour maintenir votre contenu aligné avec ce que les utilisateurs souhaitent savoir sur votre produit. + +
+ ### Brouillon d'améliorations à partir des retours utilisateurs +
+ +Examine les [retours](/fr/optimize/feedback) sur les pages — évaluations par pouces et commentaires écrits — et met à jour le contenu là où les utilisateurs ont signalé des problèmes. L'agent se concentre sur les pages présentant des signaux négatifs récurrents plutôt que sur des retours ponctuels, de sorte que les résultats s'améliorent à mesure que les retours s'accumulent. + +Vous devez activer la collecte des retours sur la page [Add-ons](https://app.mintlify.com/products/addons) avant de pouvoir utiliser cette automatisation. + +
+ ## Automatisations de maintenance +
+ +Les automatisations de maintenance automatisent les tâches routinières pour améliorer la qualité et la cohérence de votre contenu. Vous pouvez les exécuter sur un déclencheur de mise à jour de contenu ou selon un calendrier récurrent. + +L'exécution sur un déclencheur de mise à jour de contenu maintient votre contenu avec un délai minimal. L'exécution selon un calendrier est généralement plus économe en crédits car l'agent regroupe le travail sur plusieurs modifications en une seule exécution. Le compromis est un délai entre le moment où le contenu change et le moment où l'automatisation agit dessus. + +Toute automatisation de maintenance activée s'exécute sur les pull requests créées par les automatisations de contenu auto-mis à jour. Si l'automatisation de maintenance identifie des modifications nécessaires, l'agent combine le travail dans une seule pull request. Par exemple, si vous activez l'automatisation **Translate content**, l'agent ajoute des traductions à toutes les pull requests ouvertes par l'automatisation **Update from code changes**. + +
+ ### Traduire le contenu +
+ +Traduit le contenu mis à jour dans les langues cibles que vous avez sélectionnées chaque fois que des modifications sont poussées vers le dépôt de votre projet. Vous devez spécifier au moins une langue cible. Mintlify lit les [langues](/fr/organize/navigation#languages) définies dans votre `docs.json` et présélectionne les langues cibles déjà configurées. + +Pour désactiver les traductions pour une langue, supprimez tous les fichiers du répertoire de cette langue. Vous ne pouvez pas désactiver les traductions pour une langue qui contient encore du contenu publié. + + + +Trouve et corrige les liens internes et externes cassés chaque fois que des modifications de contenu sont poussées vers le dépôt de votre projet. Utile à exécuter après des réorganisations majeures de contenu ou lorsque les services externes que vous référencez modifient leurs URL. + +
+ ### Auditer les métadonnées SEO +
+ +Audite et met à jour les titres, méta descriptions, en-têtes et balises canoniques chaque fois que le contenu change. Ajoutez des instructions pour aligner les suggestions de l'agent avec votre stratégie SEO ou vos mots-clés cibles. + +
+ ### Corriger la grammaire et les fautes de frappe +
+ +Trouve et corrige les fautes de frappe, fautes d'orthographe et erreurs de grammaire chaque fois que le contenu change. Ajoutez des instructions pour préciser les exceptions concernant les termes techniques, les noms de produits ou les choix stylistiques intentionnels que l'agent ne doit pas modifier. + +
+ ### Appliquer le guide de style +
+ +Applique les règles de voix, de ton et d'écriture au contenu chaque fois qu'il change. Ajoutez des instructions pour définir les règles spécifiques que vous souhaitez appliquer ou pour lier votre guide de style. Plus vos instructions sont précises, plus les résultats sont cohérents. diff --git a/fr/changelog.mdx b/fr/changelog.mdx index ec84409e7..40702c429 100644 --- a/fr/changelog.mdx +++ b/fr/changelog.mdx @@ -5,7 +5,7 @@ rss: true noindex: true --- - +
## Brouillons de l'éditeur @@ -24,12 +24,12 @@ noindex: true - **Reprise rapide de la configuration :** Une bannière vous ramène à la bonne étape d'onboarding si vous le quittez en cours de route. - **Nouvelle checklist du tableau de bord :** Une checklist repensée sur le tableau de bord suit la progression de la configuration après l'onboarding. -
- ## Workflows en GA +
+ ## Automatisations en GA
- - **Badge bêta retiré :** [Workflows](/fr/workflows) sort de la bêta. - - **Nettoyage des exécutions bloquées :** Les exécutions de workflows longtemps en file d'attente ou bloquées expirent désormais de manière fiable après 25 heures. + - **Badge bêta retiré :** [Automatisations](/fr/automations) sort de la bêta. + - **Nettoyage des exécutions bloquées :** Les exécutions d'automatisations longtemps en file d'attente ou bloquées expirent désormais de manière fiable après 25 heures.
## Refonte de la connexion @@ -91,7 +91,7 @@ noindex: true - Les résultats de recherche s'ancrent au haut de la page ou à la section correspondant au titre plutôt qu'à des sous-sections arbitraires. - Un frontmatter incorrect ne fait plus planter les builds de page. - Les connexions Confluence passent désormais par l'interface Nango Connect. - - La bannière d'accueil des Workflows affiche un toast lorsque la suppression d'un workflow personnalisé échoue, et privilégie `errorMessage` plutôt qu'un résumé pour les exécutions en échec. + - La bannière d'accueil des Automatisations affiche un toast lorsque la suppression d'une automatisation personnalisée échoue, et privilégie `errorMessage` plutôt qu'un résumé pour les exécutions en échec. - Les libellés « Exécuté il y a x » s'actualisent pendant le polling. - Correction d'un double comptage dans l'aperçu d'utilisation lors du report des crédits. - Les badges Live à travers le produit utilisent désormais une icône de coche cohérente. @@ -103,12 +103,12 @@ noindex: true -
- ## Workflows +
+ ## Automatisations
- - **Rappels de revues en attente :** Les [workflows](/fr/workflows/reference) qui ouvrent des pull requests envoient désormais des rappels Slack lorsque les revues stagnent, afin que les PR de documentation ne restent pas oubliées. - - **Onboarding peaufiné :** Le parcours d'onboarding des workflows a été simplifié et retravaillé de bout en bout, avec des textes plus clairs, des logos d'intégration et une expérience de connexion plus fluide. + - **Rappels de revues en attente :** Les [automatisations](/fr/automations/reference) qui ouvrent des pull requests envoient désormais des rappels Slack lorsque les revues stagnent, afin que les PR de documentation ne restent pas oubliées. + - **Onboarding peaufiné :** Le parcours d'onboarding des automatisations a été simplifié et retravaillé de bout en bout, avec des textes plus clairs, des logos d'intégration et une expérience de connexion plus fluide.
## Agent Slack @@ -146,7 +146,7 @@ noindex: true - Le changement de déploiement dans l'éditeur fonctionne désormais de manière fiable. - La vue de l'historique de l'agent défile correctement. - Les liens du tableau de bord pointent désormais vers le bon chemin de l'éditeur. - - Le filtre de recherche du sélecteur d'intégrations des workflows filtre désormais les résultats comme prévu. + - Le filtre de recherche du sélecteur d'intégrations des automatisations filtre désormais les résultats comme prévu. - Les fichiers dans l'arborescence de l'éditeur sont triés par ordre alphabétique après la création d'un nouveau fichier. - Les accordéons s'ouvrent automatiquement lorsque vous accédez à leur ancre de hachage sur la même page. - L'agent de l'éditeur affiche son statut de dépassement et de crédits avant que vous n'envoyiez un message. @@ -155,7 +155,7 @@ noindex: true - La sélection de dates futures dans le tableau de bord utilise les styles corrects. - +
## Éditeur @@ -180,13 +180,13 @@ noindex: true - **Pièces jointes :** Joignez des fichiers directement à l'agent — ils sont envoyés via l'API au lieu d'être intégrés dans le prompt. - **Interruption en cours de flux :** Arrêtez l'agent pendant qu'il diffuse une réponse si vous souhaitez le réorienter. -
- ## Workflows +
+ ## Automatisations
- - **Améliorer la documentation à partir des retours** est désormais un workflow dédié qui examine les [retours récents sur les pages](/fr/optimize/feedback) et ouvre des mises à jour ciblées de la documentation à partir de ce que rapportent les utilisateurs. Voir [Workflows](/fr/workflows/reference#draft-improvements-from-user-feedback). - - Le workflow **Sync content with code** a été renommé en **Self-updating site** pour mieux refléter sa fonction. - - Les titres et le contenu des workflows dans le tableau de bord ont été retravaillés pour plus de clarté. + - **Améliorer la documentation à partir des retours** est désormais une automatisation dédiée qui examine les [retours récents sur les pages](/fr/optimize/feedback) et ouvre des mises à jour ciblées de la documentation à partir de ce que rapportent les utilisateurs. Voir [Automatisations](/fr/automations/reference#draft-improvements-from-user-feedback). + - L'automatisation **Sync content with code** a été renommée en **Self-updating site** pour mieux refléter sa fonction. + - Les titres et le contenu des automatisations dans le tableau de bord ont été retravaillés pour plus de clarté.
## API playground @@ -225,7 +225,7 @@ noindex: true - Les commandes slash et la feuille de paramètres de fichier se comportent correctement dans l'arborescence des fichiers. - +
## Éditeur web @@ -239,13 +239,13 @@ noindex: true - **Navigation par arborescence de fichiers par défaut :** Les nouveaux utilisateurs arrivent dans la vue arborescence plutôt que dans l'ancienne vue liste. - **Titre de l'onglet du navigateur :** Le nom de l'onglet du navigateur se met désormais à jour dynamiquement pour correspondre au fichier actif, afin que vous sachiez toujours quel fichier vous modifiez. -
- ## Workflows +
+ ## Automatisations
- - Le nouveau workflow **Draft improvements from assistant conversations** analyse les tendances des questions des utilisateurs et suggère des mises à jour de documentation pour combler les lacunes. Consultez [Workflows](/fr/workflows/reference#draft-improvements-from-assistant-conversations). - - Les **dépôts de contexte** peuvent désormais être configurés directement pour certains workflows, afin d'ajouter les dépôts qu'un workflow doit consulter pendant son exécution. - - Les paramètres des workflows s'ouvrent désormais dans un **panneau latéral** plutôt que dans une fenêtre modale, ce qui facilite les ajustements pendant l'examen des Workflow Runs. + - La nouvelle automatisation **Draft improvements from assistant conversations** analyse les tendances des questions des utilisateurs et suggère des mises à jour de documentation pour combler les lacunes. Consultez [Automatisations](/fr/automations/reference#draft-improvements-from-assistant-conversations). + - Les **dépôts de contexte** peuvent désormais être configurés directement pour certaines automatisations, afin d'ajouter les dépôts qu'une automatisation doit consulter pendant son exécution. + - Les paramètres des automatisations s'ouvrent désormais dans un **panneau latéral** plutôt que dans une fenêtre modale, ce qui facilite les ajustements pendant l'examen des Automation Runs.
## Améliorations de la recherche @@ -258,7 +258,7 @@ noindex: true ## Améliorations
- - **Slack Agent** : L'[agent Slack](/fr/agent/slack) prend désormais en charge **GitLab** en plus de GitHub pour les workflows basés sur les dépôts. + - **Slack Agent** : L'[agent Slack](/fr/agent/slack) prend désormais en charge **GitLab** en plus de GitHub pour les automatisations basées sur les dépôts. - **Navigation dans la barre latérale :** L'état de navigation et la position de défilement de la barre latérale sont désormais conservés lors du changement de page. - **Accessibilité :** Améliorations de l'accessibilité dans la documentation, y compris la table des matières et le panneau de l'agent sur mobile. - **Schémas AsyncAPI** : Les schémas de type array et combinatoires (`oneOf` / `anyOf` / `allOf`) s'étendent désormais pour afficher leurs attributs enfants dans la référence API. @@ -426,11 +426,11 @@ noindex: true Un nouvel assistant étape par étape sur la page de paramètres Git vous guide pour connecter un dépôt GitHub ou GitLab pour la première fois. Choisissez entre le clonage en un clic ou la sélection manuelle du dépôt, avec prise en charge de la sélection d'organisation, de la configuration de branche et de la configuration de sous-répertoire. -
- ## OAuth GitLab pour les workflows +
+ ## OAuth GitLab pour les automatisations
- Les [workflows](/automations) prennent désormais en charge les dépôts GitLab via l'authentification OAuth. Connectez votre compte GitLab depuis le tableau de bord pour utiliser les dépôts GitLab comme sources de documentation, dépôts déclencheurs ou dépôts de contexte dans vos workflows. L'agent ouvre des merge requests sur GitLab de la même manière qu'il ouvre des pull requests sur GitHub. + Les [automatisations](/fr/automations) prennent désormais en charge les dépôts GitLab via l'authentification OAuth. Connectez votre compte GitLab depuis le tableau de bord pour utiliser les dépôts GitLab comme sources de documentation, dépôts déclencheurs ou dépôts de contexte dans vos automatisations. L'agent ouvre des merge requests sur GitLab de la même manière qu'il ouvre des pull requests sur GitHub.
## Améliorations @@ -447,7 +447,7 @@ noindex: true ## Dépréciations
- - Les workflows basés sur des fichiers sont dépréciés. Créez des workflows depuis le tableau de bord à la place. Les workflows existants issus de fichiers continuent de fonctionner, mais les nouveaux workflows doivent être créés dans le tableau de bord. + - Les automatisations basées sur des fichiers sont dépréciées. Créez des automatisations depuis le tableau de bord à la place. Les automatisations existantes issues de fichiers continuent de fonctionner, mais les nouvelles automatisations doivent être créées dans le tableau de bord.
## Corrections de bugs @@ -516,7 +516,7 @@ noindex: true - Améliorations UX du CLI : URLs de connexion grisées pour plus de clarté, formatage des logs standardisé, et `mint status` affiche désormais la version du CLI. - Support de l'extension OpenAPI `x-group` pour organiser les endpoints API en groupes personnalisés. - Les lignes horizontales (`
`) sont désormais prises en charge dans le contenu MDX. - - Les [workflows](/automations) apparaissent désormais dans la boîte de réception du tableau de bord pour un suivi plus facile. La liste des workflows affiche également les noms des PR pour une identification plus rapide. + - Les [automatisations](/fr/automations) apparaissent désormais dans la boîte de réception du tableau de bord pour un suivi plus facile. La liste des automatisations affiche également les noms des PR pour une identification plus rapide. - La commande `mint export` inclut désormais les pages de référence API générées à partir des spécifications OpenAPI. - Le menu de commandes slash dans l'éditeur a été repensé avec une meilleure organisation et découvrabilité. - Amélioration de l'interface du flux de publication de l'éditeur et de l'interface de création de pages. @@ -528,7 +528,7 @@ noindex: true
- Correction des IDs de titres personnalisés qui n'étaient pas traités avant l'analyse MDX, ce qui pouvait provoquer la rupture des ancres sur certaines pages. - - Correction du modèle de workflow d'audit SEO et métadonnées qui modifiait incorrectement les pages d'endpoints API. + - Correction du modèle d'automatisation d'audit SEO et métadonnées qui modifiait incorrectement les pages d'endpoints API. - Correction du retour à la ligne du texte de l'étiquette déprécié dans le tableau de bord. - Correction du formatage en ligne (gras, italique, code) qui ne s'appliquait pas correctement dans l'éditeur dans certains contextes. - Correction des couleurs des icônes de dossiers de répertoires qui ne correspondaient pas au thème configuré. @@ -566,7 +566,7 @@ noindex: true - Refonte de la page de paramètres de configuration de l'éditeur avec une mise en page améliorée et le support de la sauvegarde automatique. - Les pages générées automatiquement à partir des spécifications OpenAPI apparaissent désormais dans l'éditeur web comme des entrées en lecture seule. - Support vidéo dans l'[aperçu en direct](/fr/editor/live-preview). Les fichiers mp4, webm et mov intégrés s'affichent désormais correctement pendant le développement local. - - Les [workflows](/automations) peuvent désormais être désactivés et réactivés depuis le tableau de bord. + - Les [automatisations](/fr/automations) peuvent désormais être désactivées et réactivées depuis le tableau de bord. - Les analyses de l'assistant affichent désormais l'utilisation ventilée par source (web vs API) dans le tableau de bord. - La recherche MCP authentifiée filtre désormais correctement les résultats en fonction des groupes d'authentification de l'utilisateur. - Les réponses de l'agent Slack affichent désormais des résumés d'appels d'outils au lieu d'appels d'outils bruts pour une information plus claire sur ce que fait l'agent. @@ -582,7 +582,7 @@ noindex: true - Correction du décalage de mise en page causé par l'infobulle de sélection de texte. - Correction de la détection visuelle des différences de badges et d'icônes dans l'éditeur. - Correction du titre et de la description OpenAPI qui ne se résolvaient pas pour les pages référencées par chemin de fichier. - - Correction du toggle d'automerge des [workflows](/automations) qui ne se désactivait pas correctement lorsqu'il était mis sur off. + - Correction du toggle d'automerge des [automatisations](/fr/automations) qui ne se désactivait pas correctement lorsqu'il était mis sur off. - Correction du playground API incluant des champs d'objets optionnels avec des enfants requis dans les corps de requête générés. - Correction de l'activation clavier de la case à cocher de sélection dans le tableau d'analyse des retours. @@ -644,7 +644,7 @@ Une nouvelle option [`api.playground.credentials`](/fr/api-playground/overview) - Les [IDs de titres personnalisés](/fr/create/text#custom-heading-ids) sont désormais pris en charge. Les résultats de recherche renvoient directement vers les sections utilisant des IDs personnalisés. - Les entrées de navigation dans `docs.json` prennent désormais en charge les liens d'ancrage (liens `#`). -- Le tableau de bord des workflows a été repensé avec une vue en cartes, un historique d'exécution plus clair, des menus déroulants d'actions et des états vides améliorés. +- Le tableau de bord des automatisations a été repensé avec une vue en cartes, un historique d'exécution plus clair, des menus déroulants d'actions et des états vides améliorés. - La navigation de l'éditeur se synchronise désormais avec le serveur pour les modifications persistantes et la résolution de conflits multi-utilisateurs. - La recherche MCP respecte désormais les permissions d'authentification, de sorte que les résultats de recherche n'incluent que les pages auxquelles l'utilisateur a accès. - [Heap analytics](/fr/integrations/analytics/heap) transfère désormais correctement les pages vues et les événements personnalisés. @@ -701,9 +701,9 @@ Invitez plusieurs membres de l'équipe dans votre organisation en une seule fois
- Les photos de profil des utilisateurs sont désormais affichées dans tout le tableau de bord pour une expérience plus personnalisée. -- Les modèles de workflows ont été mis à jour avec des prompts améliorés. -- L'historique d'exécution des workflows est désormais consultable depuis le tableau de bord avec la possibilité de surveiller le statut et de fermer les PRs. -- Les notifications Slack pour les workflows sont désormais configurables depuis le tableau de bord. +- Les modèles d'automatisations ont été mis à jour avec des prompts améliorés. +- L'historique d'exécution des automatisations est désormais consultable depuis le tableau de bord avec la possibilité de surveiller le statut et de fermer les PRs. +- Les notifications Slack pour les automatisations sont désormais configurables depuis le tableau de bord. - Améliorations des performances de l'éditeur : correction de la latence de saisie et du blocage de persistance dans les grands dépôts, virtualisation des listes de fichiers pour les dépôts contenant de nombreux fichiers. - Élimination du décalage de mise en page des cartes lors du chargement initial de la page. - Amélioration de la réactivité du sélecteur de dates dans les analytiques du tableau de bord. @@ -728,19 +728,19 @@ Invitez plusieurs membres de l'équipe dans votre organisation en une seule fois - + -
- ## Modèles de workflows +
+ ## Modèles d'automatisations
-Créez des [workflows](/automations) plus rapidement grâce aux modèles prédéfinis dans le [tableau de bord](https://dashboard.mintlify.com/products/workflows). Choisissez parmi des modèles pour la génération de changelogs, la synchronisation de documentation d'API, les ébauches de documentation de fonctionnalités, la détection de liens cassés, les audits SEO et plus encore. Les modèles incluent des prompts optimisés et des configurations de déclenchement pour vous aider à démarrer rapidement. +Créez des [automatisations](/fr/automations) plus rapidement grâce aux modèles prédéfinis dans le [tableau de bord](https://app.mintlify.com/products/automations). Choisissez parmi des modèles pour la génération de changelogs, la synchronisation de documentation d'API, les ébauches de documentation de fonctionnalités, la détection de liens cassés, les audits SEO et plus encore. Les modèles incluent des prompts optimisés et des configurations de déclenchement pour vous aider à démarrer rapidement. -
- ## Commande CLI de workflow +
+ ## Commande CLI d'automatisation
-Créez des fichiers de [workflows](/automations) depuis la ligne de commande avec la commande CLI `mint workflow`. Des invites interactives vous guident à travers le nom, le déclencheur, le contexte et les instructions. +Créez des fichiers d'[automatisations](/fr/automations) depuis la ligne de commande avec la commande CLI `mint automation`. Des invites interactives vous guident à travers le nom, le déclencheur, le contexte et les instructions.
## Agent API v2 @@ -767,7 +767,7 @@ Consultez les retours ventilés par pages individuelles dans votre tableau de bo - Intégrations YouTube et Loom disponibles dans le menu de commandes par barre oblique de l'éditeur - Contenu du pied de page et de la barre de navigation localisé par langue - L'assistant Slack affiche des indicateurs d'état pendant le traitement -- Les workflows peuvent désormais envoyer des notifications Slack avec le statut d'auto-merge +- Les automatisations peuvent désormais envoyer des notifications Slack avec le statut d'auto-merge - L'éditeur prend désormais en charge la vérification orthographique - Améliorations de la mise en page du tableau de bord pour les vues mobiles et responsives @@ -782,8 +782,8 @@ Consultez les retours ventilés par pages individuelles dans votre tableau de bo - Correction des problèmes de style d'exportation PDF - Correction du pied de page masqué sur les pages personnalisées pour les thèmes Mint, Maple, Willow et Linden - Correction des routes `.md` ne générant pas de titres à partir des slugs -- Correction des workflows cron créés via le tableau de bord qui ne se déclenchaient pas automatiquement -- Correction des exécutions récursives de workflows +- Correction des automatisations cron créées via le tableau de bord qui ne se déclenchaient pas automatiquement +- Correction des exécutions récursives d'automatisations - Correction de l'agent qui recréait une PR lorsqu'on lui demandait des modifications de suivi - Correction des erreurs de session de l'agent pour les sessions multilingues @@ -808,7 +808,7 @@ Consultez les retours ventilés par pages individuelles dans votre tableau de bo ## Améliorations - * Les workflows prennent désormais en charge jusqu’à 50 exécutions par jour, contre 20 auparavant. + * Les automatisations prennent désormais en charge jusqu’à 50 exécutions par jour, contre 20 auparavant. * [URL de base complète](/fr/organize/settings-api) désormais prise en charge dans le bac à sable d’API en configurant `api.url` dans `docs.json`. * Mise à jour de la mise en page du tableau de bord avec une navigation améliorée et un accès à l’éditeur et aux pages de paramètres via la barre latérale. * Barre de recherche de l’éditeur repensée avec une meilleure UX pour trouver des fichiers et y naviguer. @@ -826,12 +826,12 @@ Consultez les retours ventilés par pages individuelles dans votre tableau de bo * Correction du comportement de zoom sur mobile pour les champs de saisie. - - ## Workflows + + ## Automatisations - Automatisez les tâches de documentation avec les [workflows](/automations). Configurez des automatisations planifiées ou déclenchées par des événements qui exécutent l’agent pour mettre à jour votre documentation. + Automatisez les tâches de documentation avec les [automatisations](/fr/automations). Configurez des automatisations planifiées ou déclenchées par des événements qui exécutent l’agent pour mettre à jour votre documentation. - Les workflows sont en bêta et disponibles sur toutes les offres. + Les automatisations sont en bêta et disponibles sur toutes les offres. ## Commentaires et suggestions diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index ca86f59af..71bf5404c 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -81,7 +81,7 @@ mint status ## `mint workflow`
-Créez, listez et supprimez des [workflows](/fr/workflows) depuis le terminal. Nécessite une authentification avec `mint login`. +Créez, listez et supprimez des [workflows](/fr/automations) depuis le terminal. Nécessite une authentification avec `mint login`. ```bash mint workflow [flags] diff --git a/fr/credits.mdx b/fr/credits.mdx index 8e283544c..e18a0e825 100644 --- a/fr/credits.mdx +++ b/fr/credits.mdx @@ -1,6 +1,6 @@ --- title: "Tarification par crédits" -description: "Comprenez comment fonctionnent les crédits Mintlify pour les réponses de l'Assistant, les exécutions de l'agent et les workflows, y compris la manière dont nous facturons les paliers de crédits, les dépassements et les reports." +description: "Comprenez comment fonctionnent les crédits Mintlify pour les réponses de l'Assistant, les exécutions de l'agent et les automatisations, y compris la manière dont nous facturons les paliers de crédits, les dépassements et les reports." keywords: ["crédits", "facturation", "tarification", "chat IA", "messages", "paliers", "utilisation"] --- @@ -8,7 +8,7 @@ Certaines fonctionnalités de Mintlify consomment des crédits. * Réponses de l'Assistant * Exécutions de l'agent dans l'éditeur ou sur Slack -* Exécutions de workflows +* Exécutions d'automatisations Pour les informations tarifaires les plus à jour, consultez la [page Tarifs](https://mintlify.com/pricing) ou la page [Utilisation](https://app.mintlify.com/settings/organization/usage) dans votre tableau de bord. @@ -53,9 +53,9 @@ Les différentes fonctionnalités consomment des quantités de crédits différe | Exécution de l'agent dans l'éditeur | 115 | | Exécution de l'agent sur Slack | 110 | -Les workflows consomment également des crédits lors de leur exécution : +Les automatisations consomment également des crédits lors de leur exécution : -| Workflow | Crédits moyens par exécution | +| Automatisation | Crédits moyens par exécution | |:---------|:-----------------------------| | Mise à jour à partir des changements de code | 180 | | Mise à jour à partir des conversations de l'assistant | 212 | @@ -72,7 +72,7 @@ Les workflows consomment également des crédits lors de leur exécution : Utilisez les moyennes de la section [Fonctionnement des crédits](/fr/credits#how-credits-work) pour estimer vos besoins mensuels en crédits. -Par exemple, si votre site de documentation gère 500 réponses de l'Assistant par mois, cela représente environ 11 500 crédits (500 × 23). L'ajout d'un workflow hebdomadaire de détection des liens cassés ajoute environ 1 140 crédits par mois (4 × 285). +Par exemple, si votre site de documentation gère 500 réponses de l'Assistant par mois, cela représente environ 11 500 crédits (500 × 23). L'ajout d'une automatisation hebdomadaire de détection des liens cassés ajoute environ 1 140 crédits par mois (4 × 285). Après un mois d'utilisation des fonctionnalités consommant des crédits, examinez vos habitudes d'utilisation pour voir si vous devez ajuster votre palier. @@ -80,6 +80,6 @@ Après un mois d'utilisation des fonctionnalités consommant des crédits, exami ## Optimisation des coûts
-**Planifiez les workflows au lieu de les déclencher à chaque push.** Les workflows tels que les audits SEO, les vérifications du style rédactionnel et la détection des liens cassés n'ont pas besoin d'être exécutés à chaque modification de code. Les exécuter selon une planification cron quotidienne ou hebdomadaire plutôt qu'à chaque push réduit considérablement la consommation de crédits sans impact notable sur la qualité du contenu. +**Planifiez les automatisations au lieu de les déclencher à chaque push.** Les automatisations telles que les audits SEO, les vérifications du style rédactionnel et la détection des liens cassés n'ont pas besoin d'être exécutées à chaque modification de code. Les exécuter selon une planification cron quotidienne ou hebdomadaire plutôt qu'à chaque push réduit considérablement la consommation de crédits sans impact notable sur la qualité du contenu. -**Surveillez vos habitudes d'utilisation.** La page [Utilisation](https://app.mintlify.com/settings/organization/usage) de votre tableau de bord affiche une ventilation par catégorie de fonctionnalité. Si un workflow particulier consomme plus de crédits que prévu, vérifiez son déclencheur ou ses éventuelles instructions personnalisées. +**Surveillez vos habitudes d'utilisation.** La page [Utilisation](https://app.mintlify.com/settings/organization/usage) de votre tableau de bord affiche une ventilation par catégorie de fonctionnalité. Si une automatisation particulière consomme plus de crédits que prévu, vérifiez son déclencheur ou ses éventuelles instructions personnalisées. diff --git a/fr/dashboard/audit-logs.mdx b/fr/dashboard/audit-logs.mdx index c9e92f747..028fdf6fc 100644 --- a/fr/dashboard/audit-logs.mdx +++ b/fr/dashboard/audit-logs.mdx @@ -55,7 +55,7 @@ Filtrez les journaux d’audit pour trouver des activités spécifiques. | Billing | Mises à jour d’abonnements, achats de modules complémentaires et affichage des factures. | | Quota | Modifications de la politique de dépassement de quota et de la configuration des alertes. | | User | Paramètres de notification des utilisateurs individuels. | -| Workflows | Configurations de workflows et gestion des référentiels. | +| Automatisations | Configurations d'automatisations et gestion des référentiels. | | Audit log | Consultations et exportations des journaux d’audit. | | Auth | Tentatives de connexion, déconnexions et créations de sessions. | diff --git a/fr/guides/configure-automerge.mdx b/fr/guides/configure-automerge.mdx index c4dfdc9db..08efe53a2 100644 --- a/fr/guides/configure-automerge.mdx +++ b/fr/guides/configure-automerge.mdx @@ -5,10 +5,10 @@ description: "Configurez des workflows GitHub pour fusionner automatiquement les keywords: ["automerge", "ruleset", "protection de branche", "bypass"] --- -Ajoutez l'application GitHub Mintlify à la liste de contournement d'un ensemble de règles pour que l'application puisse créer et fusionner des pull requests sans que les exigences de révision et de vérification de statut ne la bloquent. Cela vous permet de configurer des [workflows](/automations/index) pour fusionner automatiquement les modifications dans `main`. +Ajoutez l'application GitHub Mintlify à la liste de contournement d'un ensemble de règles pour que l'application puisse créer et fusionner des pull requests sans que les exigences de révision et de vérification de statut ne la bloquent. Cela vous permet de configurer des [automatisations](/fr/automations/index) pour fusionner automatiquement les modifications dans `main`. - L'application GitHub Mintlify doit disposer de permissions de contournement sur **tous** les ensembles de règles ciblant votre branche de déploiement, y compris les ensembles de règles définis au niveau de l'organisation et au niveau du dépôt. Si un ensemble de règles ne contient pas l'entrée de contournement, le workflow crée une PR, mais ne la fusionne pas. + L'application GitHub Mintlify doit disposer de permissions de contournement sur **tous** les ensembles de règles ciblant votre branche de déploiement, y compris les ensembles de règles définis au niveau de l'organisation et au niveau du dépôt. Si un ensemble de règles ne contient pas l'entrée de contournement, l'automatisation crée une PR, mais ne la fusionne pas.
@@ -51,4 +51,4 @@ Répétez ces étapes pour chaque ensemble de règles qui s'applique à votre br
1. **Pour les contributeurs** : Ouvrez une PR ciblant `main`. Confirmez qu'elle nécessite toujours une approbation et des vérifications de statut réussies avant de pouvoir fusionner. -2. **Pour les workflows** : Déclenchez un workflow avec l'automerge activé. Confirmez que le workflow s'exécute et fusionne avec succès une PR. +2. **Pour les automatisations** : Déclenchez une automatisation avec l'automerge activé. Confirmez que l'automatisation s'exécute et fusionne avec succès une PR. diff --git a/fr/guides/improving-docs.mdx b/fr/guides/improving-docs.mdx index 1af6ea3e7..63b9cb593 100644 --- a/fr/guides/improving-docs.mdx +++ b/fr/guides/improving-docs.mdx @@ -123,7 +123,7 @@ Mesurer n'est utile que si cela mène à l'action. Voici quelques approches pour - **Concentrez-vous sur les parcours utilisateurs clés.** Identifiez les trois à cinq tâches les plus critiques pour le succès de votre produit et assurez-vous que la documentation soutenant ces tâches est excellente avant de vous préoccuper du reste. - Utilisez les [workflows](/automations) pour automatiser les améliorations récurrentes — comme ouvrir une pull request avec des corrections suggérées pour les pages signalées par de faibles scores de retours. + Utilisez les [automatisations](/fr/automations) pour automatiser les améliorations récurrentes — comme ouvrir une pull request avec des corrections suggérées pour les pages signalées par de faibles scores de retours.
diff --git a/fr/guides/index.mdx b/fr/guides/index.mdx index 81b22f322..cd268901f 100644 --- a/fr/guides/index.mdx +++ b/fr/guides/index.mdx @@ -19,8 +19,8 @@ Par-dessus tout, prenez en compte les besoins et les objectifs de vos utilisateu Utilisez des outils d'IA pour accélérer votre flux de travail de documentation. * [Build an in-app assistant](/fr/guides/assistant-embed) : tutoriel qui explique comment ajouter un chatbot IA dans une application React pour aider les utilisateurs à trouver des réponses dans votre documentation. -* [Configurer l'automerge](/fr/guides/configure-automerge) : ajoutez l'application GitHub Mintlify à la liste de contournement d'un ensemble de règles pour activer la fusion automatique des workflows. -* [Utiliser les workflows](/fr/guides/use-workflows) : choisissez le bon trigger de workflow, rédigez des instructions efficaces et obtenez des résultats cohérents grâce à la maintenance de contenu automatisée. +* [Configurer l'automerge](/fr/guides/configure-automerge) : ajoutez l'application GitHub Mintlify à la liste de contournement d'un ensemble de règles pour activer la fusion automatique pour les automatisations. +* [Utiliser les automatisations](/fr/guides/use-automations) : choisissez le bon déclencheur d'automatisation, rédigez des instructions efficaces et obtenez des résultats cohérents grâce à la maintenance de contenu automatisée. * [Claude Code](/fr/guides/claude-code), [Cursor](/fr/guides/cursor), [Windsurf](/fr/guides/windsurf) : guides pour utiliser des assistants de programmation IA afin de maintenir la documentation. * [GEO](/fr/guides/geo) : bonnes pratiques pour optimiser votre documentation pour les moteurs de recherche et de réponse basés sur l'IA. diff --git a/fr/guides/internationalization.mdx b/fr/guides/internationalization.mdx index 0c59a281b..1c7f1a0a7 100644 --- a/fr/guides/internationalization.mdx +++ b/fr/guides/internationalization.mdx @@ -327,7 +327,7 @@ Veillez à ce que vos traductions restent exactes et synchronisées avec votre c ### Traductions automatisées
-Pour des solutions de traduction automatique, [configurez un workflow](/automations) pour exécuter l'agent selon un calendrier ou en réponse à des pushes vers le dépôt. +Pour des solutions de traduction automatique, [configurez une automatisation](/fr/automations) pour exécuter l'agent selon un calendrier ou en réponse à des pushes vers le dépôt.
### Prestataires de traduction externes diff --git a/fr/guides/maintenance.mdx b/fr/guides/maintenance.mdx index 4b78a64b8..1dfbe6781 100644 --- a/fr/guides/maintenance.mdx +++ b/fr/guides/maintenance.mdx @@ -62,7 +62,7 @@ Suivre manuellement les dates de révision sur des centaines de pages n'est pas - Utilisez les [vérifications CI](/fr/deploy/ci) pour appliquer les exigences de frontmatter et détecter les liens cassés à chaque pull request - Utilisez les [workflows](/automations) pour exécuter des vérifications de maintenance automatisées selon un calendrier — signalant le contenu obsolète, vérifiant les métadonnées manquantes ou détectant les pages avec des scores de retour constamment bas. + Utilisez les [automatisations](/fr/automations) pour exécuter des vérifications de maintenance automatisées selon un calendrier — signalant le contenu obsolète, vérifiant les métadonnées manquantes ou détectant les pages avec des scores de retour constamment bas.
diff --git a/fr/guides/navigation.mdx b/fr/guides/navigation.mdx index bd8f90eac..9c7969e2f 100644 --- a/fr/guides/navigation.mdx +++ b/fr/guides/navigation.mdx @@ -149,7 +149,7 @@ Une cadence pratique : - **Réexaminez la structure de niveau supérieur annuellement.** À mesure que la documentation grandit, ce qui fonctionnait à 20 pages peut ne plus fonctionner à 200. - Utilisez les [workflows](/automations) pour automatiser les vérifications récurrentes comme identifier les pages avec de faibles scores de retour ou signaler les éléments de navigation qui reçoivent rarement des clics. + Utilisez les [automatisations](/fr/automations) pour automatiser les vérifications récurrentes comme identifier les pages avec de faibles scores de retour ou signaler les éléments de navigation qui reçoivent rarement des clics. Pour configurer la navigation dans Mintlify — onglets, groupes, ancres et ordre des pages — consultez la [référence de navigation](/fr/organize/navigation). diff --git a/fr/guides/seo.mdx b/fr/guides/seo.mdx index 2afdeb0e0..50db71b0f 100644 --- a/fr/guides/seo.mdx +++ b/fr/guides/seo.mdx @@ -148,7 +148,7 @@ Une approche pratique : - Vérifiez les liens cassés avec `mint broken-links` avant de publier - Utilisez les [workflows](/automations) pour automatiser les tâches de maintenance SEO. + Utilisez les [automatisations](/fr/automations) pour automatiser les tâches de maintenance SEO. Une documentation obsolète crée un second problème au-delà du SEO : si les utilisateurs trouvent votre page via la recherche mais que l'information est erronée, ils perdent confiance en votre documentation. diff --git a/fr/guides/style-and-tone.mdx b/fr/guides/style-and-tone.mdx index 3a15b219b..0937e6f7f 100644 --- a/fr/guides/style-and-tone.mdx +++ b/fr/guides/style-and-tone.mdx @@ -145,7 +145,7 @@ Les principes de rédaction ne perdurent que s'ils font partie d'un flux de trav - **Guides de style existants :** Plutôt que d'écrire des règles à partir de zéro, commencez par un guide établi. Le [Google Developer Documentation Style Guide](https://developers.google.com/style), le [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) et le [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse) sont tous gratuits et largement utilisés. - Utilisez un [workflow](/automations) pour exécuter un audit de style selon un calendrier ou chaque fois que des modifications sont poussées vers votre dépôt de documentation. + Utilisez une [automatisation](/fr/automations) pour exécuter un audit de style selon un calendrier ou chaque fois que des modifications sont poussées vers votre dépôt de documentation.
diff --git a/fr/guides/use-automations.mdx b/fr/guides/use-automations.mdx new file mode 100644 index 000000000..7818ad9c1 --- /dev/null +++ b/fr/guides/use-automations.mdx @@ -0,0 +1,126 @@ +--- +title: "Utiliser les automatisations" +description: "Utilisez les automatisations Mintlify pour automatiser la maintenance récurrente de la documentation : choisissez le bon déclencheur, rédigez des instructions efficaces et obtenez des résultats d'agent cohérents." +keywords: ["automations", "automation", "automate", "automation guide", "automation instructions", "agent automation", "self updating"] +--- + +Les automatisations exécutent l'agent automatiquement afin que votre contenu reste précis sans effort manuel. Ce guide explique comment choisir la bonne automatisation, la configurer efficacement et rédiger des instructions qui produisent des résultats cohérents. + +
+ ## Quand utiliser les automatisations +
+ +Les automatisations conviennent particulièrement aux tâches qui sont : + +- **Répétitives** : la même tâche s'exécute régulièrement selon un calendrier prévisible ou chaque fois qu'un événement spécifique se produit. +- **Chronophages** : des tâches qui prennent du temps à effectuer manuellement mais qui suivent un schéma cohérent. +- **Réactives** : des tâches qui doivent se produire automatiquement en réponse à des modifications de code ou de contenu, comme la mise à jour de la documentation après la livraison d'une fonctionnalité. + +Pour les tâches ponctuelles ou exploratoires, utilisez l'agent directement dans le [dashboard](https://app.mintlify.com) ou depuis Slack. + +
+ ## Choisir un déclencheur +
+ +Chaque automatisation s'exécute selon l'un des trois types de déclencheurs. Choisissez celui qui correspond au moment où vous avez besoin que le travail soit effectué. + +| Déclencheur | À utiliser lorsque | +|---|---| +| Mise à jour de contenu | La tâche doit s'exécuter chaque fois que le contenu de votre projet change — traduction de nouvelles pages, correction de liens cassés ou audit des métadonnées SEO. | +| Modification de code | La tâche doit s'exécuter lorsque le code source change — mise à jour des spécifications d'API ou de la documentation après la fusion d'une PR. | +| Calendrier personnalisé | La tâche doit s'exécuter à une cadence fixe, quoi qu'il arrive — publication de changelogs hebdomadaires ou vérifications grammaticales périodiques. | + +
+ ## Automatisations prédéfinies +
+ +Mintlify inclut des automatisations prédéfinies pour les tâches de maintenance de contenu les plus courantes. Activez l'une d'elles depuis la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard. + +Consultez [Automatisations prédéfinies](/fr/automations/reference) pour plus de détails. + +
+ ## Automatisations personnalisées +
+ +Créez une automatisation personnalisée pour les tâches non couvertes par les options prédéfinies. Les automatisations personnalisées vous donnent un contrôle total sur le déclencheur, les instructions et les dépôts de contexte. + +Consultez [Créer une automatisation personnalisée](/fr/automations/create) pour les étapes de configuration. + +
+ ### Rédiger des instructions efficaces +
+ +Les instructions d'automatisation personnalisée sont des prompts que l'agent suit à chaque exécution. La qualité de vos instructions affecte directement la cohérence des résultats. + +**Décrivez le résultat, pas seulement la tâche.** Indiquez à l'agent à quoi ressemble une tâche aboutie. + + +```text Moins efficace +Review the API reference pages. +``` + +```text Plus efficace +Review every page in the /api-reference directory. For each endpoint, confirm that the request parameters, response fields, and example payloads match the OpenAPI spec in the api/openapi.yaml file. Open a pull request with corrections for any discrepancies you find. +``` + + +**Rédigez une procédure.** Les agents suivent les instructions étape par étape plus fiablement que les prompts ouverts. + +```text Exemple de procédure +1. Read the merged pull request diff from the trigger repository. +2. Identify any changed API endpoints, parameters, or response shapes. +3. Search the documentation for pages that reference those endpoints. +4. Update the affected pages to match the changes in the pull request. +5. Open a pull request with a summary of the pages you changed and why. +``` + +**Restez précis dans la portée.** Une automatisation qui fait une chose bien est plus fiable qu'une qui tente d'en faire plusieurs. Divisez les tâches complexes en plusieurs automatisations. + +**Spécifiez les fichiers et les répertoires.** Plus vous êtes précis sur l'endroit où l'agent doit chercher, moins il passe de temps à le faire. + +```text Exemple avec des chemins spécifiques +Check every MDX file in the /content directory for broken internal links (links beginning with /). +For each broken link, either fix the path or remove the link if no replacement exists. +``` + +
+ ### Utiliser des dépôts de contexte +
+ +Pour les automatisations personnalisées et certaines automatisations prédéfinies, vous pouvez ajouter des dépôts de contexte que l'agent lit lorsque l'automatisation s'exécute. + +Ajoutez des dépôts de contexte lorsque : +- Votre contenu fait référence à du code, des API ou des configurations qui résident dans un dépôt distinct. +- Vous souhaitez que l'agent compare votre contenu au code source pour décider de ce qu'il faut mettre à jour. +- Le prompt d'automatisation fait référence à des fichiers en dehors de votre dépôt de projet Mintlify. + +Vous pouvez ajouter jusqu'à 10 dépôts de contexte par automatisation. + +
+ ### Mode de mise à jour +
+ +Décidez du niveau de relecture souhaité avant que les modifications soient mises en ligne. + +- **Automatique** : les modifications sont fusionnées directement dans votre dépôt de projet Mintlify sans relecture. Idéal pour les tâches à faible risque et à fréquence élevée comme la traduction, les vérifications grammaticales et les corrections de liens. +- **Exiger une relecture** : l'agent ouvre une pull request et un humain la relit avant la fusion. Idéal pour les tâches qui modifient le sens du contenu, comme la synchronisation avec les modifications de code ou la mise à jour des références d'API. + +
+ ## Contrôler l'utilisation des crédits +
+ +Chaque exécution d'automatisation consomme des crédits. Par exemple, la plupart des exécutions de l'automatisation **update from code changes** coûtent entre 40 et 180 crédits. Les exécutions complexes qui mettent à jour de nombreuses pages coûtent davantage. + +La planification de tâches cron à des moments précis vous donne un contrôle plus fin sur l'utilisation des crédits. Par exemple, exécutez une automatisation une fois par jour ou une fois par semaine pour savoir exactement combien de pull requests elle crée par mois. Les automatisations déclenchées par push peuvent varier davantage d'un mois à l'autre car elles dépendent de la fréquence à laquelle le contenu ou le code change. + +
+ ## Examiner et améliorer les résultats d'automatisation +
+ +Les automatisations s'exécutent automatiquement, mais elles bénéficient d'un examen périodique. + +1. Ouvrez l'onglet **Runs** sur la page [Automations](https://app.mintlify.com/products/automations) pour voir l'historique récent et le statut des exécutions. +2. Cliquez sur une exécution pour lire le résumé de l'agent et examiner les pull requests qu'elle a ouvertes. +3. Si les résultats sont incohérents, affinez vos instructions : ajoutez des procédures plus spécifiques, réduisez la portée des fichiers ou divisez l'automatisation en tâches plus petites. + +Quelques cycles d'examen après l'activation d'une nouvelle automatisation suffisent généralement à affiner les instructions. diff --git a/fr/guides/use-workflows.mdx b/fr/guides/use-workflows.mdx deleted file mode 100644 index 5f45d760b..000000000 --- a/fr/guides/use-workflows.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "Utiliser les workflows" -description: "Utilisez les workflows Mintlify pour automatiser la maintenance de la documentation : choisissez le bon trigger, rédigez des instructions efficaces." -keywords: ["workflows", "automatisation", "automatiser", "guide des workflows", "instructions de workflow", "automatisation de l'agent", "auto-mise à jour"] ---- - -Les workflows exécutent l'agent automatiquement afin que votre contenu reste exact sans effort manuel. Ce guide explique comment choisir le bon workflow, le configurer efficacement et rédiger des instructions qui produisent des résultats cohérents. - -
- ## Quand utiliser les workflows -
- -Les workflows conviennent particulièrement aux tâches qui sont : - -- **Répétitives**—La même tâche s'exécute régulièrement selon une planification prévisible ou chaque fois qu'un événement spécifique se produit. -- **Chronophages**—Des tâches longues à effectuer manuellement mais qui suivent un schéma cohérent. -- **Réactives**—Des tâches qui doivent se déclencher automatiquement en réponse à des changements de code ou de contenu, comme la mise à jour de la documentation après la livraison d'une fonctionnalité. - -Pour des tâches ponctuelles ou exploratoires, utilisez l'agent directement dans le [tableau de bord](https://app.mintlify.com) ou depuis Slack. - -
- ## Choisir un trigger -
- -Chaque workflow s'exécute avec l'un des trois types de trigger. Choisissez celui qui correspond au moment où vous avez besoin que le travail soit effectué. - -| Trigger | À utiliser quand | -|---|---| -| Mise à jour de contenu | La tâche doit s'exécuter chaque fois que le contenu de votre projet change — traduire de nouvelles pages, corriger des liens rompus ou auditer les métadonnées SEO. | -| Changement de code | La tâche doit s'exécuter lorsque le code source change — mettre à jour les spécifications d'API ou la documentation après la fusion d'une PR. | -| Planification personnalisée | La tâche doit s'exécuter à une cadence fixe quoi qu'il arrive — publier des changelogs hebdomadaires ou exécuter des vérifications grammaticales périodiques. | - -
- ## Workflows prédéfinis -
- -Mintlify inclut des workflows prédéfinis pour les tâches de maintenance de contenu les plus courantes. Activez l'un d'entre eux depuis la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) de votre tableau de bord. - -Consultez [Workflows prédéfinis](/fr/workflows/reference) pour plus de détails. - -
- ## Workflows personnalisés -
- -Créez un workflow personnalisé pour les tâches qui ne sont pas couvertes par les options prédéfinies. Les workflows personnalisés vous donnent un contrôle total sur le trigger, les instructions et les dépôts de contexte. - -Consultez [Créer un workflow personnalisé](/fr/workflows/create) pour les étapes de configuration. - -
- ### Rédiger des instructions efficaces -
- -Les instructions d'un workflow personnalisé sont des prompts que l'agent suit à chaque exécution. La qualité de vos instructions affecte directement la cohérence des résultats. - -**Décrivez le résultat, pas seulement la tâche.** Indiquez à l'agent à quoi ressemble un travail terminé. - - -```text Moins efficace -Examinez les pages de référence de l'API. -``` - -```text Plus efficace -Examinez chaque page du répertoire /api-reference. Pour chaque endpoint, confirmez que les paramètres de la requête, les champs de réponse et les exemples de payloads correspondent à la spécification OpenAPI dans le fichier api/openapi.yaml. Ouvrez une pull request avec des corrections pour toutes les divergences que vous trouvez. -``` - - -**Rédigez une procédure.** Les agents suivent des instructions étape par étape de manière plus fiable que des prompts ouverts. - -```text Exemple de procédure -1. Lisez le diff de la pull request fusionnée du dépôt déclencheur. -2. Identifiez les endpoints, paramètres ou formes de réponse de l'API qui ont changé. -3. Recherchez dans la documentation les pages qui font référence à ces endpoints. -4. Mettez à jour les pages concernées pour qu'elles correspondent aux changements de la pull request. -5. Ouvrez une pull request avec un résumé des pages que vous avez modifiées et pourquoi. -``` - -**Limitez le périmètre.** Un workflow qui fait une chose bien est plus fiable qu'un workflow qui essaie d'en faire plusieurs. Répartissez les tâches complexes entre plusieurs workflows. - -**Spécifiez les fichiers et les répertoires.** Plus vous êtes précis sur l'endroit où l'agent doit chercher, moins il passe de temps à explorer. - -```text Exemple avec des chemins spécifiques -Vérifiez chaque fichier MDX du répertoire /content pour repérer les liens internes rompus (liens commençant par /). -Pour chaque lien rompu, corrigez le chemin ou supprimez le lien s'il n'existe pas de remplacement. -``` - -
- ### Utiliser des dépôts de contexte -
- -Pour les workflows personnalisés et certains workflows prédéfinis, vous pouvez ajouter des dépôts de contexte que l'agent lit lors de l'exécution du workflow. - -Ajoutez des dépôts de contexte lorsque : -- Votre contenu fait référence à du code, à des APIs ou à de la configuration qui se trouvent dans un dépôt distinct. -- Vous souhaitez que l'agent compare votre contenu au code source lorsqu'il décide de ce qu'il doit mettre à jour. -- Le prompt du workflow fait référence à des fichiers en dehors du dépôt de votre projet Mintlify. - -Vous pouvez ajouter jusqu'à 10 dépôts de contexte par workflow. - -
- ### Mode de mise à jour -
- -Décidez du niveau de revue que vous souhaitez avant la publication des changements. - -- **Automatique** : Les changements sont fusionnés directement dans le dépôt de votre projet Mintlify sans revue. Idéal pour des tâches à faible risque et haute fréquence comme la traduction, les vérifications grammaticales et la correction de liens. -- **Exiger une revue** : L'agent ouvre une pull request et une personne la relit avant la fusion. Idéal pour les tâches qui modifient le sens du contenu, comme la synchronisation avec les changements de code ou la mise à jour des références d'API. - -
- ## Contrôler l'utilisation des crédits -
- -Chaque exécution de workflow consomme des crédits. Par exemple, la plupart des exécutions du workflow **mettre à jour à partir des changements de code** coûtent entre 40 et 180 crédits. Les exécutions complexes qui mettent à jour de nombreuses pages coûtent davantage. - -Planifier des tâches cron pour qu'elles s'exécutent à des moments précis vous permet de contrôler plus finement l'utilisation des crédits. Par exemple, vous pouvez exécuter un workflow une fois par jour ou une fois par semaine pour savoir exactement combien de pull requests un workflow crée par mois, plutôt que d'avoir une variation mensuelle en fonction des changements de contenu ou de code. - -
- ## Examiner et améliorer les résultats des workflows -
- -Les workflows s'exécutent automatiquement, mais ils gagnent à être examinés périodiquement. - -1. Ouvrez l'onglet **Runs** de la page [Workflows](https://app.mintlify.com/products/workflows) pour voir l'historique récent des exécutions et leur statut. -2. Cliquez sur une exécution pour lire le résumé de l'agent et examiner les pull requests qu'il a ouvertes. -3. Si les résultats sont incohérents, affinez vos instructions : ajoutez des procédures plus précises, réduisez la portée des fichiers ou répartissez le workflow en tâches plus petites. - -Quelques cycles de revue après l'activation d'un nouveau workflow suffisent généralement à affiner les instructions. diff --git a/fr/organize/navigation.mdx b/fr/organize/navigation.mdx index 366794ffc..56f508293 100644 --- a/fr/organize/navigation.mdx +++ b/fr/organize/navigation.mdx @@ -817,7 +817,7 @@ Nous prenons actuellement en charge les langues suivantes pour la localisation : } ``` -Pour les traductions automatisées, [configurez un workflow](/automations) pour exécuter l’agent selon un calendrier ou en réponse à des pushes vers le dépôt. +Pour les traductions automatisées, [configurez une automatisation](/fr/automations) pour exécuter l’agent selon un calendrier ou en réponse à des pushes vers le dépôt.
diff --git a/fr/what-is-mintlify.mdx b/fr/what-is-mintlify.mdx index a6df0f324..1528f3ce3 100644 --- a/fr/what-is-mintlify.mdx +++ b/fr/what-is-mintlify.mdx @@ -43,7 +43,7 @@ Les fonctionnalités d’IA intégrées aident les personnes et les systèmes d L’**Assistant** permet à vos utilisateurs de poser des questions et d’obtenir des réponses sourcées à partir de votre contenu. -L’**agent** aide votre équipe à créer et à maintenir le contenu en générant des mises à jour à partir de workflows planifiés, de pull requests (demandes de fusion) fusionnées dans votre référentiel de fonctionnalités, ou de fils de discussion Slack. +L’**agent** aide votre équipe à créer et à maintenir le contenu en générant des mises à jour à partir d’automatisations planifiées, de pull requests (demandes de fusion) fusionnées dans votre référentiel de fonctionnalités, ou de fils de discussion Slack. Consultez la section [Documentation native à l’IA](/fr/ai-native) pour une vue d’ensemble de toutes les fonctionnalités d’IA. diff --git a/fr/workflows/create.mdx b/fr/workflows/create.mdx deleted file mode 100644 index 6934cb89f..000000000 --- a/fr/workflows/create.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Créer un workflow personnalisé" -description: "Créez un workflow Mintlify personnalisé avec un trigger planifié ou push, des dépôts de contexte et un prompt d’agent pour automatiser vos tâches docs." -keywords: ["automatisation", "automatiser", "cron", "agent", "workflow personnalisé"] ---- - -import GitlabWorkflowSetup from '/snippets/fr/gitlab-workflow-setup.mdx'; - -
- ## Prérequis -
- -- Un projet Mintlify connecté à un dépôt GitHub ou GitLab -- Pour GitHub : l'[application GitHub Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans le workflow -- Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous) - -
- ## Créer un workflow personnalisé -
- - - L'agent s'exécute dans un sandbox isolé avec un accès restreint à Internet. Il ne peut pas installer de packages ou d'outils supplémentaires au moment de l'exécution. Les prompts qui font référence à des outils indisponibles peuvent produire des résultats inattendus ou échouer. - - -1. Ouvrez la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) dans votre tableau de bord. -2. Cliquez sur **Create a custom workflow**. -3. Configurez le nom du workflow, le trigger, les instructions, les dépôts de contexte, les intégrations et le mode de mise à jour. -4. Cliquez sur **Create workflow**. - -
- ## Rédiger des instructions efficaces -
- -Des instructions de workflow efficaces se concentrent sur une seule tâche et définissent un résultat clair et vérifiable. Les workflows présentent une certaine variabilité car les agents ne sont pas déterministes, mais des instructions bien formatées produisent des résultats plus cohérents. - -- **Décrivez le résultat.** Indiquez à l'agent à quoi doit ressembler le résultat d'une exécution réussie. -- **Rédigez une procédure.** Donnez à l'agent un guide étape par étape à suivre. -- **Limitez le périmètre.** Répartissez les tâches complexes entre plusieurs workflows plutôt que de les combiner dans un seul prompt. - -Pour plus d'exemples et de modèles, consultez [Utiliser les workflows](/fr/guides/use-workflows). - - - Examinez la sortie de vos workflows personnalisés pour confirmer qu'ils fonctionnent comme prévu. Mettez à jour vos instructions pour améliorer les résultats. - - - - -
- ## Supprimer un workflow personnalisé -
- -La suppression d'un workflow est définitive et supprime sa configuration ainsi que son historique d'exécution. - -1. Accédez à la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) dans votre tableau de bord. -2. Cliquez sur le bouton de paramètres à côté d'un workflow. -3. Cliquez sur **Delete**. diff --git a/fr/workflows/index.mdx b/fr/workflows/index.mdx deleted file mode 100644 index 3af428fdf..000000000 --- a/fr/workflows/index.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Vue d'ensemble des workflows" -sidebarTitle: "Vue d'ensemble" -description: "Automatisez la maintenance du contenu avec les workflows Mintlify : exécutez l’agent selon une planification ou en réponse aux pushes GitHub et GitLab." -keywords: ["automatisation", "automatiser", "cron", "agent", "workflows"] -boost: 5 ---- - -Les workflows exécutent l'agent automatiquement selon une planification ou en réponse à des changements dans un dépôt. Chaque workflow définit un prompt pour l'agent et un trigger qui indique quand l'exécuter. Les workflows prennent en charge à la fois les dépôts GitHub et GitLab. - -Lorsqu'un workflow s'exécute, l'agent lit le contenu de votre projet et les dépôts connectés, puis suit le prompt pour effectuer les mises à jour. - - -Utilisez des workflows qui s'exécutent selon une planification pour les tâches récurrentes, comme la publication de changelogs ou l'audit des métadonnées SEO. - -Utilisez des workflows qui se déclenchent sur des changements de contenu ou de code pour la maintenance réactive, comme les traductions ou la mise à jour du contenu lorsque le code source change. - - -
- ## Types de trigger -
- -Les workflows prennent en charge trois types de trigger. - -- **Mise à jour de contenu**—S'exécute lorsque des changements de contenu sont poussés vers votre dépôt de projet Mintlify, y compris les fusions de pull requests et les pushes directs. -- **Changement de code**—S'exécute lorsqu'une pull request est fusionnée dans un dépôt de code source connecté. -- **Planification personnalisée**—S'exécute selon une planification récurrente. Les workflows sont mis en file d'attente dans les 10 minutes suivant l'heure planifiée. - -Chaque workflow a exactement un trigger. Vous ne pouvez pas combiner des types de trigger dans un seul workflow. - -
- ## Limites d'utilisation -
- -Les exécutions de workflows comptent dans votre utilisation de crédits. Consultez votre utilisation de crédits, configurez les dépassements et gérez votre forfait de crédits sur la page [Utilisation](https://app.mintlify.com/settings/organization/usage) de votre tableau de bord. - -Chaque workflow peut s'exécuter jusqu'à 500 fois par jour. Les exécutions en échec ne comptent pas dans cette limite. - -
- ## Étapes suivantes -
- - - - Référence pour tous les workflows prédéfinis : triggers, modes de mise à jour et configuration requise. - - - Activez les workflows prédéfinis et configurez les triggers, le mode de mise à jour et le contexte. - - - Créez un workflow avec votre propre trigger, vos instructions et vos dépôts de contexte. - - - Choisissez le bon trigger, rédigez des instructions efficaces et examinez les résultats. - - diff --git a/fr/workflows/manage.mdx b/fr/workflows/manage.mdx deleted file mode 100644 index f6c965f75..000000000 --- a/fr/workflows/manage.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Gérer les workflows" -description: "Activez, désactivez, déclenchez et supprimez des workflows depuis votre tableau de bord. Configurez triggers GitHub ou GitLab, contexte et automerge." -keywords: ["cron", "push", "automerge", "contexte", "instructions de workflow", "trigger", "désactiver un workflow", "activer un workflow"] ---- - -import GitlabWorkflowSetup from '/snippets/fr/gitlab-workflow-setup.mdx'; - -
- ## Prérequis -
- -- Un projet Mintlify connecté à un dépôt GitHub ou GitLab -- Pour GitHub : l'[application GitHub Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans le workflow -- Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous) - - - Vous pouvez également créer, lister et supprimer des workflows depuis le terminal avec [`mint workflow`](/fr/cli/commands#mint-workflow). La CLI est utile pour les scripts et l'intégration continue ; le tableau de bord est le moyen le plus simple de configurer et de surveiller les exécutions des workflows. - - -
- ## Activer un workflow -
- -1. Ouvrez la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) dans votre tableau de bord. -2. Cliquez sur l'interrupteur à côté d'un workflow pour l'activer. - - Le tableau de bord des workflows. - Le tableau de bord des workflows. - - - Si le workflow peut s'exécuter avec les paramètres par défaut, il s'active immédiatement. Sinon, le panneau de paramètres s'ouvre pour vous permettre de renseigner les configurations requises. - - Les options de configuration d'un workflow. - Les options de configuration d'un workflow. - -3. Si le panneau de paramètres s'ouvre, renseignez les champs requis. -4. Cliquez sur **Turn on workflow**. - -Pour modifier les paramètres d'un workflow actif, cliquez sur le bouton de paramètres à côté de celui-ci. Utilisez l'interrupteur dans l'en-tête du modal pour activer ou désactiver le workflow sans quitter la vue des paramètres. - -
- ## Configurations -
- -
- ### Trigger -
- -Chaque workflow possède un trigger par défaut qui contrôle quand il s'exécute. Pour changer le trigger, sélectionnez une autre option dans le panneau de paramètres. - -- **Mise à jour de contenu**—S'exécute chaque fois que vous poussez du contenu vers votre dépôt de projet, y compris les fusions de pull requests et les pushes directs. -- **Changement de code**—S'exécute lorsqu'une pull request est fusionnée dans un dépôt de code source connecté. Vous devez spécifier au moins un dépôt source. -- **Planification personnalisée**—S'exécute selon une planification récurrente que vous définissez. Les workflows sont mis en file d'attente dans les 10 minutes suivant l'heure planifiée. - -
- ### Mode de mise à jour -
- -Chaque workflow possède un mode par défaut pour la façon dont il effectue les mises à jour. Soit en fusionnant directement les changements dans votre dépôt de contenu, soit en ouvrant une pull request pour examen. - -Pour exiger une revue avant que le workflow mette à jour votre contenu, sélectionnez **Require review** dans le panneau de paramètres. - - - Pour les dépôts GitHub, les mises à jour automatiques nécessitent que l'application GitHub Mintlify dispose des autorisations de bypass sur chaque ruleset ciblant votre branche de déploiement, y compris les rulesets au niveau de l'organisation et au niveau du dépôt. Voir [Configurer l'automerge](/fr/guides/configure-automerge) pour les instructions de configuration. - - Pour les dépôts GitLab, l'automerge utilise la connexion OAuth GitLab et nécessite au moins le rôle Mainteneur sur chaque projet. - - -
- ### Dépôts de contexte -
- -Pour les workflows personnalisés et certains workflows prédéfinis, vous pouvez ajouter des dépôts de contexte — des dépôts de code source supplémentaires que l'agent lit lors de l'exécution du workflow. Cela est utile lorsque le prompt de votre workflow fait référence à du code, à des APIs ou à d'autres contenus qui se trouvent en dehors du dépôt de votre projet. - -Vous pouvez ajouter jusqu'à 10 dépôts de contexte par workflow. Pour chaque dépôt GitHub, l'application GitHub Mintlify doit être installée. Ajoutez des dépôts sur la page [Paramètres de l'application GitHub](https://app.mintlify.com/settings/organization/github-app). - -
- ### Intégrations -
- -Pour les workflows personnalisés et le workflow **Update from code changes**, vous pouvez activer les [intégrations de l'agent](/fr/agent/integrations) connectées afin que l'agent puisse récupérer du contexte depuis des outils comme Slack, Notion ou Linear lors de l'exécution du workflow. - -Pour activer des intégrations pour un workflow, ouvrez ses paramètres et sélectionnez les intégrations que vous souhaitez que l'agent utilise dans la section **Available integrations**. Seules les intégrations déjà connectées pour votre organisation apparaissent dans la liste. Consultez [Intégrations de l'agent](/fr/agent/integrations) pour plus d'informations sur la connexion des intégrations. - -
- ### Notifications Slack -
- -Envoyez des messages Slack aux canaux sélectionnés lors de l'exécution des workflows. Utilisez les notifications Slack pour tenir votre équipe informée de l'activité des workflows en cours sans avoir à surveiller le dashboard. - -Pour activer les notifications Slack, installez l'[application Slack de Mintlify](/fr/agent/slack) dans votre workspace, puis ajoutez un ou plusieurs canaux de notification dans la section **Notification channels** des paramètres de votre workflow. - -Une fois activées, Mintlify publie dans les canaux configurés lorsque : - -- Un workflow ouvre une pull request pour revue. -- Une pull request ouverte par un workflow attend une revue depuis **3 jours** sans avoir été fusionnée. Mintlify envoie un rappel quotidien jusqu'à ce que la pull request soit fusionnée ou fermée. Lorsque la pull request est résolue, le rappel d'origine est mis à jour avec un texte barré pour que les alertes obsolètes ne restent pas affichées. -- Un workflow fusionne une pull request ou échoue. - -Les rappels de revue en attente s'appliquent à tout workflow configuré pour ouvrir des pull requests à des fins de revue (voir [Mode de mise à jour](#update-mode)). Ils ne se déclenchent que lorsque des canaux de notification Slack sont configurés pour le workflow. - -
- ### Instructions -
- -Ajoutez des instructions optionnelles qui s'ajoutent au prompt de base du workflow à chaque exécution. Utilisez-les pour ajuster le style, le ton ou d'autres comportements propres au projet sans modifier la logique principale du workflow. - -
- ### Langues cibles -
- -Lorsque vous activez le workflow **traduire le contenu**, sélectionnez une ou plusieurs langues à maintenir synchronisées avec votre contenu source. - -- Mintlify lit les [langues](/fr/organize/navigation#languages) définies dans votre `docs.json` pour identifier votre langue par défaut et présélectionne les langues cibles déjà configurées. -- Vous devez sélectionner au moins une langue cible pour enregistrer le workflow. -- Vous ne pouvez pas sélectionner la langue source comme cible. - -Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres du workflow et en modifiant le champ **Translate to**. - - - -
- ## Désactiver un workflow -
- -1. Accédez à la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) dans votre tableau de bord. -2. Cliquez sur l'interrupteur à côté d'un workflow pour le désactiver. - -Lorsque vous réactivez un workflow planifié, Mintlify recalcule la prochaine heure d'exécution à partir de l'heure actuelle. - -
- ## Consulter l'historique des exécutions -
- -Chaque workflow conserve un journal des exécutions passées, comprenant le statut et un résumé des modifications apportées. - -1. Accédez à la page [Workflow Runs](https://app.mintlify.com/products/workflows) dans votre tableau de bord. -2. Utilisez les menus déroulants pour filtrer par workflows spécifiques ou par statut. - - Page des exécutions de workflows montrant les filtres par workflow et par statut. - Page des exécutions de workflows montrant les filtres par workflow et par statut. - diff --git a/fr/workflows/reference.mdx b/fr/workflows/reference.mdx deleted file mode 100644 index d25de7379..000000000 --- a/fr/workflows/reference.mdx +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Workflows prédéfinis" -description: "Référence pour tous les workflows Mintlify prédéfinis : trigger par défaut, mode de mise à jour, prise en charge des dépôts de contexte et configurations." -keywords: ["prédéfini", "automatisation", "par défaut"] ---- - -Mintlify inclut des workflows prédéfinis pour les tâches de maintenance de documentation les plus courantes. Chaque workflow possède un prompt de base et une configuration par défaut. Vous pouvez personnaliser le trigger, le mode de mise à jour et les instructions depuis la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) de votre tableau de bord. - -
- ## Workflows de contenu auto-mis à jour -
- -Les workflows de contenu auto-mis à jour effectuent des mises à jour en fonction du contexte que vous définissez afin que votre contenu reste exact et à jour. - -
- ### Mettre à jour à partir des changements de code -
- -Surveille vos dépôts de code source et ouvre des pull requests pour mettre à jour le contenu lors de changements qui affectent les utilisateurs. Vous pouvez exécuter ce workflow selon une planification, ce qui consomme généralement moins de crédits, ou à chaque pull request de code source. Par défaut, ce workflow s'exécute deux fois par semaine (mardi et jeudi). Les autres workflows planifiés conservent leur planification hebdomadaire par défaut. - -Lorsque vous exécutez le workflow selon une planification, l'agent lit toutes les pull requests de code source fusionnées depuis la dernière exécution du workflow. Il regroupe les changements connexes qui nécessitent des mises à jour de contenu dans une pull request dans votre dépôt de projet Mintlify. S'il existe des pull requests non fusionnées issues d'exécutions précédentes, l'agent ajoute les changements pertinents aux pull requests existantes. L'agent cite l'origine des changements dans vos dépôts de code source. - -Lorsque vous exécutez le workflow à chaque pull request de code source, l'agent crée une pull request de mise à jour de contenu chaque fois que vous fusionnez une pull request de code source qui nécessite des mises à jour de contenu. Utilisez la variante basée sur les pushes lorsque vous souhaitez que les mises à jour de contenu apparaissent dès que le code est livré, plutôt que regroupées selon une planification. - -Vous pouvez activer les [intégrations de l'agent](/fr/agent/integrations) pour ce workflow afin de donner à l'agent un contexte supplémentaire depuis des outils comme Slack ou Linear lors de la détermination de ce qu'il faut mettre à jour. - -
- ### Rédiger un changelog -
- -Crée une entrée de changelog selon une planification récurrente. Ajoutez des dépôts de code source comme contexte pour que l'agent dispose de plus de détails sur l'évolution de votre produit. Sans dépôts de contexte, l'agent travaille à partir de vos mises à jour de contenu pour rédiger une entrée de changelog. - -
- ### Rédiger des améliorations à partir des conversations de l'assistant -
- -Analyse les tendances des questions de votre [assistant](/fr/assistant/index) pour identifier les lacunes dans votre contenu, puis ouvre une pull request pour les combler. Plus vos utilisateurs ont de conversations avec l'assistant, plus l'agent dispose de signal pour travailler. Exécutez ce workflow selon une planification récurrente pour maintenir le contenu aligné sur ce que les utilisateurs veulent savoir sur votre produit. - -
- ### Rédiger des améliorations à partir des retours des utilisateurs -
- -Analyse les [retours](/fr/optimize/feedback) sur les pages — évaluations pouce haut/bas et commentaires écrits — et met à jour le contenu là où les utilisateurs ont signalé des problèmes. L'agent se concentre sur les pages présentant des signaux négatifs récurrents plutôt que sur des retours isolés, de sorte que les résultats s'améliorent à mesure que les retours s'accumulent. - -Vous devez activer la collecte de retours sur la page [Modules complémentaires](https://app.mintlify.com/products/addons) avant de pouvoir utiliser ce workflow. - -
- ## Workflows de maintenance -
- -Les workflows de maintenance automatisent les tâches routinières pour améliorer la qualité et la cohérence de votre contenu. Vous pouvez les exécuter avec un trigger de mise à jour de contenu ou selon une planification récurrente. - -L'exécution avec un trigger de mise à jour de contenu maintient votre contenu avec un délai minimal. L'exécution selon une planification est généralement plus économe en crédits, car l'agent regroupe le travail à travers plusieurs changements dans une seule exécution, mais il y a un délai entre le moment où le contenu change et le moment où le workflow de maintenance agit dessus. - -Tous les workflows de maintenance activés s'exécutent sur les pull requests créées par les workflows de contenu auto-mis à jour. Si le workflow de maintenance nécessite des changements, l'agent combine le travail dans une seule pull request. Par exemple, si vous activez le workflow **traduire le contenu**, l'agent ajoute des traductions aux pull requests ouvertes par le workflow **mettre à jour à partir des changements de code**. - -
- ### Traduire le contenu -
- -Traduit le contenu mis à jour dans les langues cibles que vous sélectionnez chaque fois que des changements sont poussés vers votre dépôt de projet. Vous devez spécifier au moins une langue cible. Mintlify lit les [langues](/fr/organize/navigation#languages) définies dans votre `docs.json` et présélectionne les langues cibles déjà configurées. - -Pour désactiver les traductions pour une langue, supprimez tous les fichiers du répertoire de cette langue. Vous ne pouvez pas désactiver les traductions pour une langue qui contient encore du contenu publié. - - - -Trouve et corrige les liens internes et externes rompus chaque fois que des changements de contenu sont poussés vers votre dépôt de projet. Utile à exécuter après des réorganisations majeures de contenu ou lorsque les services externes auxquels vous faites référence changent leurs URLs. - -
- ### Auditer les métadonnées SEO -
- -Audite et met à jour les titres, méta-descriptions, en-têtes et balises canoniques chaque fois que le contenu change. Ajoutez des instructions pour aligner les suggestions de l'agent avec votre stratégie SEO ou vos mots-clés cibles. - -
- ### Corriger la grammaire et les fautes de frappe -
- -Trouve et corrige les fautes de frappe, les fautes d'orthographe et les erreurs grammaticales chaque fois que le contenu change. Ajoutez des instructions pour spécifier des exceptions concernant les termes techniques, les noms de produits ou les choix stylistiques intentionnels que l'agent ne doit pas modifier. - -
- ### Appliquer la charte de style -
- -Applique les règles de voix, de ton et d'écriture au contenu chaque fois qu'il change. Ajoutez des instructions pour définir les règles spécifiques que vous souhaitez faire respecter ou liez votre charte de style. Plus vos instructions sont précises, plus les résultats sont cohérents. diff --git a/zh.json b/zh.json index b7215cf2e..5fb10e0e7 100644 --- a/zh.json +++ b/zh.json @@ -87,6 +87,15 @@ "zh/agent/workflows" ] }, + { + "group": "自动化", + "pages": [ + "zh/automations/index", + "zh/automations/reference", + "zh/automations/manage", + "zh/automations/create" + ] + }, { "group": "组件", "pages": [ @@ -271,6 +280,7 @@ "pages": [ "zh/guides/assistant-embed", "zh/guides/configure-automerge", + "zh/guides/use-automations", "zh/guides/claude-code", "zh/guides/cursor", "zh/guides/geo", diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index ae515ead3..bdb35cbbe 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -26,7 +26,7 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议 * 在你的文档中搜索并修改代码示例和 API 参考。 * 引用任何已安装 Mintlify GitHub 应用的仓库中的源代码。 * 从 Slack、Notion、Linear 和 Jira 等已连接的应用中拉取实时上下文。 -* 通过工作流自动化文档维护工作。 +* 通过自动化处理文档维护工作。 * 回答与你的文档和技术写作相关的问题。 * 处理代码审查反馈并维护文档质量。 * 在知识从 Slack 对话和拉取请求中流失之前，将其记录下来。 @@ -82,6 +82,6 @@ npx skills add https://mintlify.com/docs 使用更聚焦的提示词以获得更好的效果。 - - 使用工作流自动化重复性任务和文档维护。 + + 使用自动化处理重复性任务和文档维护。 \ No newline at end of file diff --git a/zh/agent/use-cases.mdx b/zh/agent/use-cases.mdx index c27365455..adcec9f31 100644 --- a/zh/agent/use-cases.mdx +++ b/zh/agent/use-cases.mdx @@ -1,7 +1,7 @@ --- title: "使用场景" description: "探索使用 Mintlify agent 自动更新文档、沉淀知识和维护准确文档的实际案例。" -keywords: ["agent 工作流", "文档工作流", "自动化示例"] +keywords: ["agent 自动化", "文档自动化", "自动化示例"] --- agent 可以协助完成多种文档相关任务。以下示例展示了几种将 agent 集成到文档流程中的方式。选择一种适合你团队当前工作方式的方案，并根据你的具体需求进行调整。 @@ -78,13 +78,13 @@ agent 可以协助完成多种文档相关任务。以下示例展示了几种 例如：`@mintlify Users are getting confused by step 3 in the setup guide. What might be making it unclear?`. -
- ## 使用工作流实现自动化 +
+ ## 使用自动化实现自动化
-创建工作流，以自动化处理重复性任务和响应式维护任务，例如在你为你的产品添加新功能时撰写更新日志或更新内容。 +创建自动化，以处理重复性任务和响应式维护任务，例如在你为你的产品添加新功能时撰写更新日志或更新内容。 -参见[工作流概览](/automations/index)了解更多信息。 +参见[自动化概览](/zh/automations/index)了解更多信息。
## 使用 API 实现自动化 diff --git a/zh/ai-native.mdx b/zh/ai-native.mdx index 1523f9eeb..4645bd158 100644 --- a/zh/ai-native.mdx +++ b/zh/ai-native.mdx @@ -23,7 +23,7 @@ keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"] [agent](/zh/agent) 可帮助你撰写和维护文档。它会基于你的提示、拉取请求 (PR；亦称“合并请求”/Merge Request) 以及 Slack 讨论串，创建包含建议更改的拉取请求。将 agent 添加到你的 Slack 工作区，你的团队成员即可通过与 agent 对话协同维护文档。你也可以通过 [API](/zh/api/agent/v2/create-agent-job) 将 agent 嵌入自定义应用。 -创建 [workflows](/automations/index)，让 agent 按预设计划或在推送到存储库时运行。每个 workflow 都为 agent 定义提示词以及触发运行的条件。 +创建 [automations](/zh/automations/index)，让 agent 按预设计划或在推送到存储库时运行。每个自动化都为 agent 定义提示词以及触发运行的条件。 配置常用工具 (如 [Cursor](/zh/guides/cursor)、[Claude Code](/zh/guides/claude-code) 和 [Windsurf](/zh/guides/windsurf)) ，以对齐 Mintlify 架构、你的风格指南和最佳实践。 @@ -60,7 +60,7 @@ Mintlify 会为你的文档托管 `llms.txt` 和 `skill.md` 文件。这些行 配置 AI 助手以搜索外部网站，或在其无法回答问题时将用户引导至你的支持团队。 - + 按计划或在发生 push 事件时自动获取文档更新。 diff --git a/zh/automations/create.mdx b/zh/automations/create.mdx new file mode 100644 index 000000000..a63064016 --- /dev/null +++ b/zh/automations/create.mdx @@ -0,0 +1,56 @@ +--- +title: "创建自定义自动化" +description: "通过计划或推送触发器、上下文仓库以及 agent 提示词创建自定义 Mintlify 自动化，从而自动执行周期性文档任务。" +keywords: ["automation", "automate", "cron", "agent", "custom automation"] +--- + +import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; + +
+ ## 前置条件 +
+ +- 一个已连接到 GitHub 或 GitLab 仓库的 Mintlify 项目 +- 对于 GitHub：在你计划用于自动化的每个仓库上都安装 [Mintlify GitHub 应用](/zh/deploy/github) +- 对于 GitLab：已连接的 GitLab 账户（请参见下方[GitLab 设置](#gitlab-setup)） + +
+ ## 创建自定义自动化 +
+ + + agent 运行在受限互联网访问的隔离沙箱中。它无法在运行时安装额外的包或工具。引用不可用工具的提示词可能产生意外结果或失败。 + + +1. 在控制台中打开 [Automations](https://app.mintlify.com/products/automations) 页面。 +2. 点击 **Create a custom automation**。 +3. 配置自动化名称、触发器、指令、上下文仓库、集成和更新模式。 +4. 点击 **Create automation**。 + +
+ ## 撰写有效的指令 +
+ +有效的自动化指令聚焦于单一任务，并定义清晰、可验证的结果。由于 agent 是非确定性的，自动化结果会有所差异，但格式良好的指令能产生更一致的结果。 + +- **描述结果。** 告诉 agent 一次成功的运行应该是什么样的。 +- **撰写流程。** 给 agent 一份按步骤执行的指南。 +- **保持范围窄。** 将复杂任务拆分到多个自动化中，而不是合并到一个提示词里。 + +更多示例和模式请参见[使用自动化](/zh/guides/use-automations)。 + + + 审查你自定义自动化的输出，以确认它们按预期运行。更新你的指令以改进结果。 + + + + +
+ ## 删除自定义自动化 +
+ +删除自动化是永久性的，会移除其配置和运行历史。 + +1. 进入控制台中的 [Automations](https://app.mintlify.com/products/automations) 页面。 +2. 点击自动化旁边的 设置按钮。 +3. 点击 **Delete**。 diff --git a/zh/automations/index.mdx b/zh/automations/index.mdx new file mode 100644 index 000000000..c27ea727d --- /dev/null +++ b/zh/automations/index.mdx @@ -0,0 +1,56 @@ +--- +title: "自动化概览" +sidebarTitle: "概览" +description: "使用 Mintlify 自动化来自动维护内容。按计划运行 agent，或在 GitHub 与 GitLab 仓库推送时触发运行。" +keywords: ["automation", "automate", "cron", "agent", "automations"] +boost: 5 +--- + +自动化会按计划或在仓库发生变更时自动运行 agent。每个自动化都会为 agent 定义一个提示词，以及触发其运行的条件。自动化同时支持 GitHub 和 GitLab 仓库。 + +当自动化运行时，agent 会读取你的项目内容以及任何已连接的仓库，然后按照提示词进行更新。 + + +对于周期性任务，例如发布更新日志或审计 SEO 元数据，使用按计划运行的自动化。 + +对于响应式维护任务，例如翻译或在源代码变更时更新内容，使用由内容或代码变更触发的自动化。 + + +
+ ## 触发器类型 +
+ +自动化支持三种触发器类型。 + +- **内容更新（Content update）**：当内容推送到你的 Mintlify 项目仓库时运行，包括 pull request 合并和直接推送。 +- **代码变更（Code change）**：当已连接的源代码仓库中有 pull request 合并时运行。 +- **自定义计划（Custom schedule）**：按周期性计划运行。自动化会在预定时间的 10 分钟内进入队列。 + +每个自动化只能有一个触发器。你无法在单个自动化中组合多种触发器类型。 + +
+ ## 使用限制 +
+ +自动化运行会计入你的积分使用量。可在控制台的 [Usage](https://app.mintlify.com/settings/organization/usage) 页面查看积分使用情况、设置超额用量并管理你的积分套餐。 + +每个自动化每天最多可运行 500 次。失败的运行不计入此限制。 + +
+ ## 后续步骤 +
+ + + + 所有预定义自动化的参考：触发器、更新模式和必需配置。 + + + 启用预定义自动化并配置触发器、更新模式和上下文。 + + + 使用你自己的触发器、指令和上下文仓库构建自动化。 + + + 选择合适的触发器、撰写有效的指令并审查结果。 + + diff --git a/zh/automations/manage.mdx b/zh/automations/manage.mdx new file mode 100644 index 000000000..5831c9462 --- /dev/null +++ b/zh/automations/manage.mdx @@ -0,0 +1,148 @@ +--- +title: "管理自动化" +description: "从控制台启用、禁用、触发和删除自动化。配置 GitHub 或 GitLab 触发器、计划、上下文仓库及 automerge。" +keywords: ["cron", "push", "automerge", "context", "automation instructions", "trigger", "disable automation", "enable automation"] +--- + +import GitlabAutomationSetup from '/snippets/zh/gitlab-automation-setup.mdx'; + +
+ ## 前置条件 +
+ +- 一个已连接到 GitHub 或 GitLab 仓库的 Mintlify 项目 +- 对于 GitHub：在你计划用于自动化的每个仓库上都安装 [Mintlify GitHub 应用](/zh/deploy/github) +- 对于 GitLab：已连接的 GitLab 账户（请参见下方[GitLab 设置](#gitlab-setup)） + + + 你也可以通过 [`mint automation`](/zh/cli/commands#mint-automation) 在终端中创建、列出和删除自动化。CLI 适合用于脚本和 CI；而控制台是配置和监控自动化运行最简单的方式。 + + +
+ ## 启用自动化 +
+ +1. 在控制台中打开 [Automations](https://app.mintlify.com/products/automations) 页面。 +2. 点击自动化旁边的开关以启用它。 + + 自动化控制台。 + 自动化控制台。 + + + 如果自动化可以使用默认设置运行，它会立即激活。否则，设置面板会打开，让你填写任何必需的配置。 + + 自动化的配置选项。 + 自动化的配置选项。 + +3. 如果设置面板打开，请填写必填字段。 +4. 点击 **Turn on automation**。 + +要更改已激活自动化的设置，点击它旁边的 设置按钮。使用弹窗头部的开关可以在不离开设置视图的情况下启用或禁用自动化。 + +
+ ## 配置 +
+ +
+ ### 触发器 +
+ +每个自动化都有一个默认触发器来控制运行时机。要更改触发器，在设置面板中选择不同选项。 + +- **内容更新（Content update）**：每当你向项目仓库推送内容时运行，包括 pull request 合并和直接推送。 +- **代码变更（Code change）**：当已连接的源代码仓库中有 pull request 合并时运行。你必须至少指定一个源仓库。 +- **自定义计划（Custom schedule）**：按你定义的周期性计划运行。自动化会在预定时间的 10 分钟内进入队列。 + +
+ ### 更新模式 +
+ +每个自动化都有一种默认的更新方式：要么直接将更改合并到你的内容仓库，要么打开一个 pull request 以供审查。 + +要在自动化更新内容之前要求审查，请在设置面板中选择 **Require review**。 + + + 对于 GitHub 仓库，自动更新要求 Mintlify GitHub 应用对所有针对部署分支的规则集（包括组织级和仓库级规则集）拥有绕过权限。设置说明请参见[配置 automerge](/zh/guides/configure-automerge)。 + + 对于 GitLab 仓库，automerge 使用 GitLab OAuth 连接，并且要求每个项目至少具有 Maintainer 角色。 + + +
+ ### 上下文仓库 +
+ +对于自定义自动化和部分预定义自动化，你可以添加上下文仓库——自动化运行时 agent 读取的额外源代码仓库。这在你的自动化提示词引用了项目仓库之外的代码、API 或其他内容时很有用。 + +每个自动化最多可添加 10 个上下文仓库。对于每个 GitHub 仓库，请安装 Mintlify GitHub 应用。在 [GitHub App settings](https://app.mintlify.com/settings/organization/github-app) 页面添加仓库。 + +
+ ### 集成 +
+ +对于自定义自动化和 **Update from code changes** 自动化，你可以启用已连接的 [agent 集成](/zh/agent)，以便 agent 在自动化运行时从 Slack、Notion 或 Linear 等工具拉取上下文。 + +要为自动化启用集成，请打开其设置，在 **Available integrations** 部分选择你希望 agent 使用的集成。只有已为你的组织连接的集成会出现在列表中。关于连接集成的更多信息请参见 [Agent 集成](/zh/agent)。 + +
+ ### Slack 通知 +
+ +在自动化运行时向一个或多个频道发送 Slack 消息。 + +要启用 Slack 通知： +1. 在你的工作区安装 [Mintlify Slack 应用](/zh/agent/slack)。 +2. 在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面点击 **Turn on Slack notifications**。 + + 启用 Slack 通知按钮。 + 启用 Slack 通知按钮。 + +3. 选择一个或多个通知频道。 +4. 点击 **Save changes**。 + +启用后，Mintlify 会在以下情况下向所选频道发送消息： + +- 自动化打开了 pull request 等待审查。 +- 自动化的 pull request 已等待审查三天。 +- 自动化合并了 pull request 或未能完成。 + +
+ ### 指令 +
+ +添加可选指令，这些指令会在每次运行时附加到自动化的基础提示词。使用它们来调整风格、语气或其他项目特有的行为，而无需更改核心自动化逻辑。 + +
+ ### 目标语言 +
+ +启用 **Translate content** 自动化时，选择一种或多种语言以与你的源内容保持同步。 + +- Mintlify 会读取你 `docs.json` 中定义的[languages](/zh/organize/navigation#languages)以识别默认语言，并预选已配置的目标语言。 +- 你必须至少选择一个目标语言才能保存自动化。 +- 你无法选择源语言作为目标。 + +随时可通过打开自动化设置并编辑 **Translate to** 字段来添加目标语言。 + + + +
+ ## 禁用自动化 +
+ +1. 进入控制台中的 [Automations](https://app.mintlify.com/products/automations) 页面。 +2. 点击自动化旁边的开关以禁用它。 + +当你重新启用一个计划自动化或更改其计划时，Mintlify 会从当前时间重新计算下次运行时间。已禁用的自动化不会保留待运行时间。 + +
+ ## 查看运行历史 +
+ +每个自动化都会保存历史运行日志，包括状态和所做更改的摘要。 + +1. 进入控制台中的 [Automation Runs](https://app.mintlify.com/products/automations) 页面。 +2. 使用下拉菜单按特定自动化或状态进行过滤。 + + 自动化运行页面，显示自动化和状态过滤器。 + 自动化运行页面，显示自动化和状态过滤器。 + diff --git a/zh/automations/reference.mdx b/zh/automations/reference.mdx new file mode 100644 index 000000000..563ad56a2 --- /dev/null +++ b/zh/automations/reference.mdx @@ -0,0 +1,87 @@ +--- +title: "预定义自动化" +description: "所有预定义 Mintlify 自动化的参考，包括默认触发器、更新模式、上下文仓库支持及必需配置。" +keywords: ["predefined", "automation", "default"] +--- + +Mintlify 为最常见的文档维护任务提供了预定义自动化。每个自动化都有一个基础提示词和默认配置。你可以在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面自定义触发器、更新模式和指令。 + +
+ ## 自更新内容自动化 +
+ +自更新内容自动化会基于你定义的上下文进行更新，以确保你的内容保持准确和最新。 + +
+ ### 从代码变更中更新 +
+ +监控你的源代码仓库，并针对影响用户的变更打开 pull request 以更新内容。你可以按计划运行该自动化（通常消耗更少积分），或在每次源代码 pull request 时运行。默认情况下，该自动化每周运行两次（周二和周四）。 + +按计划运行时，agent 会读取自上次自动化运行以来所有已合并的源代码 pull request。它会将需要内容更新的相关变更分组到 Mintlify 项目仓库的单个 pull request 中。如果之前运行有未合并的 pull request，agent 会将相关变更追加到现有 pull request 中。agent 会注明变更来自你的源代码仓库的哪些位置。 + +按每个源代码 pull request 运行时，每当你合并一个需要内容更新的代码变更，agent 都会打开一个内容更新 pull request。当你希望内容更新随代码发布立即出现，而不是按计划批量处理时，使用基于推送的变体。 + +你可以为该自动化启用 [agent 集成](/zh/agent)，让 agent 在判断需要更新的内容时，从 Slack 或 Linear 等工具获取额外上下文。 + +
+ ### 起草更新日志 +
+ +按周期性计划创建更新日志条目。将源代码仓库添加为上下文，让 agent 对你的产品如何变更有更多细节。如果没有上下文仓库，agent 会根据你的内容更新撰写更新日志条目。 + +
+ ### 从 AI 助手对话中起草改进 +
+ +审查来自你的 [AI 助手](/zh/assistant/index) 的提问趋势，以识别你内容中的缺口，然后打开一个 pull request 来解决它们。用户与 AI 助手的对话越多，agent 可参考的信号就越多。按周期性计划运行该自动化，以使内容与用户希望了解的产品信息保持一致。 + +
+ ### 从用户反馈中起草改进 +
+ +审查页面[反馈](/zh/optimize/feedback)——点赞/点踩评分和书面评论——并在用户报告问题的位置更新内容。agent 关注存在反复出现的负面信号的页面，而不是一次性反馈，因此随着反馈累积，结果会变得更好。 + +在使用此自动化之前，你必须在 [Add-ons](https://app.mintlify.com/products/addons) 页面启用反馈收集。 + +
+ ## 维护自动化 +
+ +维护自动化将常规任务自动化，以提高内容的质量和一致性。你可以通过内容更新触发器或周期性计划来运行它们。 + +在内容更新触发器上运行时，可以以最小延迟维护你的内容。按计划运行通常更节省积分，因为 agent 会在一次运行中批量处理多次变更的工作。代价是从内容变更到自动化对其执行操作之间存在延迟。 + +任何已启用的维护自动化都会在自更新内容自动化创建的 pull request 上运行。如果维护自动化识别出需要的更改，agent 会将工作合并到单个 pull request 中。例如，如果你启用了 **Translate content** 自动化，agent 会将翻译添加到 **Update from code changes** 自动化打开的任何 pull request 中。 + +
+ ### 翻译内容 +
+ +每当变更推送到你的项目仓库时，将更新后的内容翻译为你选择的目标语言。你必须至少指定一种目标语言。Mintlify 会读取你 `docs.json` 中定义的[languages](/zh/organize/navigation#languages)，并预选已配置的目标语言。 + +要禁用某语言的翻译，请删除该语言目录中的所有文件。你无法为仍有已发布内容的语言禁用翻译。 + + + +每当内容变更推送到你的项目仓库时，查找并修复失效的内部和外部链接。在大规模内容重组之后，或当你引用的外部服务更改其 URL 时运行该自动化很有用。 + +
+ ### 审计 SEO 元数据 +
+ +每当内容变更时，审计并更新标题、meta 描述、标题和规范标签。添加指令以使 agent 的建议与你的 SEO 策略或目标关键词保持一致。 + +
+ ### 修复语法与拼写 +
+ +每当内容变更时，查找并修复错别字、拼写错误和语法错误。添加指令以指定 agent 不应更改的技术术语、产品名称或有意的风格选择例外。 + +
+ ### 应用风格指南 +
+ +每当内容变更时，将语态、语气和写作规则应用到内容上。添加指令以定义你想强制执行的具体规则，或链接到你的风格指南。指令越精确，结果越一致。 diff --git a/zh/changelog.mdx b/zh/changelog.mdx index ef0123072..8610515d7 100644 --- a/zh/changelog.mdx +++ b/zh/changelog.mdx @@ -5,7 +5,7 @@ rss: true noindex: true --- - +
## 编辑器草稿 @@ -24,12 +24,12 @@ noindex: true - **快速回到设置：** 如果您中途离开，横幅会带您返回到正确的入门步骤。 - **新的仪表盘检查清单：** 仪表盘上重新设计的检查清单会在入门完成后跟踪设置进度。 -
- ## Workflows 正式发布 +
+ ## Automations 正式发布
- - **移除 Beta 标签：** [Workflows](/automations) 已退出 beta 阶段。 - - **陈旧运行清理器：** 长时间排队或停滞的工作流运行现在会在 25 小时后可靠超时。 + - **移除 Beta 标签：** [Automations](/zh/automations) 已退出 beta 阶段。 + - **陈旧运行清理器：** 长时间排队或停滞的自动化运行现在会在 25 小时后可靠超时。
## 登录页面重新设计 @@ -91,7 +91,7 @@ noindex: true - 搜索结果锚定到页面顶部或标题匹配的章节，而不是任意子章节。 - 错误的 frontmatter 不再导致页面构建崩溃。 - Confluence 连接现在通过 Nango Connect 界面路由。 - - 工作流主页横幅在自定义工作流删除失败时会显示 toast 提示，并在运行失败时优先使用 `errorMessage` 而非摘要。 + - 自动化主页横幅在自定义自动化删除失败时会显示 toast 提示，并在运行失败时优先使用 `errorMessage` 而非摘要。 - "x 之前运行"标签在轮询期间会持续更新。 - 修复了积分滚存时使用概览中的重复计数问题。 - 产品中各处的实时徽章现在使用一致的对勾图标。 @@ -103,12 +103,12 @@ noindex: true -
- ## Workflows +
+ ## Automations
- - **陈旧审查提醒：** 打开 pull request 的 [workflows](https://www.mintlify.com/docs/workflows/reference) 现在会在审查停滞时发送 Slack 提醒，避免文档 PR 被遗忘。 - - **入门流程优化：** 工作流入门流程已端到端简化和重新设计，文案更清晰，集成图标更明显，连接体验更顺畅。 + - **陈旧审查提醒：** 打开 pull request 的 [automations](https://www.mintlify.com/docs/automations/reference) 现在会在审查停滞时发送 Slack 提醒，避免文档 PR 被遗忘。 + - **入门流程优化：** 自动化入门流程已端到端简化和重新设计，文案更清晰，集成图标更明显，连接体验更顺畅。
## Slack 代理 @@ -146,7 +146,7 @@ noindex: true - 在编辑器中切换部署现在工作稳定。 - 代理历史视图滚动正常。 - 仪表盘链接现在指向正确的编辑器路径。 - - 工作流集成选择器的搜索过滤器现在按预期过滤结果。 + - 自动化集成选择器的搜索过滤器现在按预期过滤结果。 - 创建新文件后，编辑器文件树会按字母顺序排列。 - 当您在同一页面导航到锚点时，折叠面板会自动展开。 - 编辑器代理在您发送消息之前显示超额和积分状态。 @@ -155,7 +155,7 @@ noindex: true - 仪表盘中的未来日期选择使用正确的样式。 - +
## 网页编辑器 @@ -169,13 +169,13 @@ noindex: true - **默认使用文件树导航：** 新入驻用户默认进入文件树视图，而非旧版列表视图。 - **浏览器标签页标题：** 浏览器标签页名称现在会动态更新为当前文件，便于识别正在编辑的文件。 -
- ## 工作流 +
+ ## 自动化
- - 新增 **Improve content from assistant conversations** 工作流，可分析用户提问趋势并建议文档更新以填补缺口。详见 [Workflows](https://www.mintlify.com/docs/workflows/enable#improve-docs-from-assistant-chats)。 - - 部分工作流现在可以直接配置 **Context repositories**，以便添加工作流运行时应引用的仓库。 - - 工作流设置现在在 **侧边面板** 中打开，而非弹窗，便于在查看 Workflow Runs 时调整设置。 + - 新增 **Improve content from assistant conversations** 自动化，可分析用户提问趋势并建议文档更新以填补缺口。详见 [Automations](https://www.mintlify.com/docs/automations/reference#draft-improvements-from-assistant-conversations)。 + - 部分自动化现在可以直接配置 **Context repositories**，以便添加自动化运行时应引用的仓库。 + - 自动化设置现在在 **侧边面板** 中打开，而非弹窗，便于在查看 Automation Runs 时调整设置。
## 搜索改进 @@ -356,11 +356,11 @@ noindex: true Git 设置页面上的新分步向导将指导你首次连接 GitHub 或 GitLab 仓库。可选择一键克隆或手动选择仓库，支持组织选择、分支配置和子目录设置。 -
- ## 工作流的 GitLab OAuth +
+ ## 自动化的 GitLab OAuth
- [工作流](/automations)现在通过 OAuth 身份验证支持 GitLab 仓库。从仪表板连接你的 GitLab 账户，以便在工作流中使用 GitLab 仓库作为文档源、触发仓库或上下文仓库。Agent 在 GitLab 上创建 merge request，就像在 GitHub 上创建 pull request 一样。 + [自动化](/zh/automations)现在通过 OAuth 身份验证支持 GitLab 仓库。从仪表板连接你的 GitLab 账户，以便在自动化中使用 GitLab 仓库作为文档源、触发仓库或上下文仓库。Agent 在 GitLab 上创建 merge request，就像在 GitHub 上创建 pull request 一样。
## 改进 @@ -377,7 +377,7 @@ noindex: true ## 弃用
- - 基于文件的工作流已弃用。请改为从仪表板创建工作流。现有的基于文件的工作流将继续运行，但新工作流必须在仪表板中创建。 + - 基于文件的自动化已弃用。请改为从仪表板创建自动化。现有的基于文件的自动化将继续运行，但新自动化必须在仪表板中创建。
## 错误修复 @@ -446,7 +446,7 @@ noindex: true - CLI 用户体验改进：登录 URL 显示为灰色以提高清晰度、标准化日志格式，以及 `mint status` 现在显示 CLI 版本。 - 支持 OpenAPI `x-group` 扩展，用于将 API 端点组织到自定义分组中。 - MDX 内容现在支持水平分割线（`
`）。 - - [工作流](/automations)现在会在仪表板收件箱中显示，便于跟踪。工作流列表还会显示 PR 名称以便快速识别。 + - [自动化](/zh/automations)现在会在仪表板收件箱中显示，便于跟踪。自动化列表还会显示 PR 名称以便快速识别。 - `mint export` 命令现在包含从 OpenAPI 规范生成的 API 参考页面。 - 编辑器中的斜杠命令菜单已重新设计，改进了组织和可发现性。 - 改进了编辑器发布流程和页面创建界面的 UI。 @@ -458,7 +458,7 @@ noindex: true
- 修复了自定义标题 ID 在 MDX 解析之前未被处理的问题，该问题可能导致某些页面上的锚点失效。 - - 修复了 SEO 和元数据审计工作流模板错误修改 API 端点页面的问题。 + - 修复了 SEO 和元数据审计自动化模板错误修改 API 端点页面的问题。 - 修复了仪表板中已弃用标签文本换行的问题。 - 修复了编辑器中内联格式（粗体、斜体、代码）在某些上下文中无法正确应用的问题。 - 修复了目录文件夹图标颜色与配置主题不匹配的问题。 @@ -496,7 +496,7 @@ noindex: true - 重新设计了编辑器配置设置页面，改进了布局并支持自动保存。 - 从 OpenAPI 规范自动生成的页面现在以只读条目的形式显示在 Web 编辑器中。 - [实时预览](/zh/editor/live-preview)中的视频支持。嵌入的 mp4、webm 和 mov 文件现在在本地开发期间可以正确渲染。 - - [工作流](/automations)现在可以从仪表板禁用和重新启用。 + - [自动化](/zh/automations)现在可以从仪表板禁用和重新启用。 - 助手分析现在在仪表板中显示按来源（Web 与 API）分类的使用情况。 - 经过身份验证的 MCP 搜索现在可以根据用户的身份验证组正确过滤结果。 - Slack agent 响应现在显示工具调用摘要，而不是原始工具调用，以更清晰地展示 agent 正在执行的操作。 @@ -512,7 +512,7 @@ noindex: true - 修复了文本选择工具提示导致的布局偏移。 - 修复了编辑器中 badge 和图标视觉差异检测的问题。 - 修复了通过文件路径引用的页面的 OpenAPI 标题和描述无法解析的问题。 - - 修复了[工作流](/automations)自动合并开关在设置为关闭时无法正确禁用的问题。 + - 修复了[自动化](/zh/automations)自动合并开关在设置为关闭时无法正确禁用的问题。 - 修复了 API playground 在生成的请求体中包含带有必需子项的可选对象字段的问题。 - 修复了反馈分析表选择复选框的键盘激活问题。 @@ -574,7 +574,7 @@ noindex: true - 现已支持[自定义标题 ID](/zh/create/text#custom-heading-ids)。搜索结果可深链接到使用自定义 ID 的章节。 - `docs.json` 中的导航条目现已支持锚点链接（`#` 链接）。 -- Workflow dashboard 重新设计，新增卡片视图、更清晰的运行历史、操作下拉菜单和改进的空状态。 +- Automation dashboard 重新设计，新增卡片视图、更清晰的运行历史、操作下拉菜单和改进的空状态。 - 编辑器导航现在与服务器同步，支持持久化更改和多用户冲突解决。 - MCP 搜索现在遵循身份验证权限，搜索结果仅包含用户有权访问的页面。 - [Heap analytics](/zh/integrations/analytics/heap) 现在可以正确转发页面浏览和自定义事件。 @@ -631,9 +631,9 @@ noindex: true
- 用户头像现在在整个 dashboard 中显示，提供更个性化的体验。 -- Workflow 模板已更新，包含改进的 prompt。 -- Workflow 运行历史现可从 dashboard 查看，支持监控状态和关闭 PR。 -- Workflow 的 Slack 通知现可从 dashboard 配置。 +- Automation 模板已更新，包含改进的 prompt。 +- Automation 运行历史现可从 dashboard 查看，支持监控状态和关闭 PR。 +- Automation 的 Slack 通知现可从 dashboard 配置。 - 编辑器性能改进：修复了大型仓库中的输入延迟和持久化阻塞问题，对包含大量文件的仓库虚拟化了文件列表。 - 消除了页面初始加载时卡片的布局偏移。 - 改进了 dashboard 分析日期选择器的响应性。 @@ -658,19 +658,19 @@ noindex: true - + -
- ## Workflow 模板 +
+ ## Automation 模板
-使用 [dashboard](https://dashboard.mintlify.com/products/workflows) 中的预置模板更快地创建 [workflows](/automations)。可选择的模板包括：changelog 生成、API 文档同步、功能文档草稿、断链检测、SEO 审计等。模板包含优化的 prompt 和触发器配置，帮助你快速上手。 +使用 [dashboard](https://app.mintlify.com/products/automations) 中的预置模板更快地创建 [automations](/zh/automations)。可选择的模板包括：changelog 生成、API 文档同步、功能文档草稿、断链检测、SEO 审计等。模板包含优化的 prompt 和触发器配置，帮助你快速上手。 -
- ## Workflow CLI 命令 +
+ ## Automation CLI 命令
-使用 `mint workflow` CLI 命令从命令行创建 [workflows](/automations) 文件。交互式提示将引导你完成名称、触发器、上下文和指令的配置。 +使用 `mint automation` CLI 命令从命令行创建 [automations](/zh/automations) 文件。交互式提示将引导你完成名称、触发器、上下文和指令的配置。
## Agent API v2 @@ -697,7 +697,7 @@ noindex: true - 编辑器斜杠命令菜单中现提供 YouTube 和 Loom 嵌入功能 - 页脚和导航栏内容按语言本地化 - Slack 助手在处理时显示状态指示器 -- Workflows 现在可以发送包含自动合并状态的 Slack 通知 +- Automations 现在可以发送包含自动合并状态的 Slack 通知 - 编辑器现在支持拼写检查 - 改进了移动端和响应式视图的 dashboard 布局 @@ -712,8 +712,8 @@ noindex: true - 修复了 PDF 导出样式问题 - 修复了 Mint、Maple、Willow 和 Linden 主题中自定义页面的页脚隐藏问题 - 修复了 `.md` 路由不能从 slug 生成标题的问题 -- 修复了通过 dashboard 创建的 cron workflow 不能自动触发的问题 -- 修复了 workflow 递归运行的问题 +- 修复了通过 dashboard 创建的 cron automation 不能自动触发的问题 +- 修复了 automation 递归运行的问题 - 修复了 agent 在被要求进行后续更改时重新创建 PR 的问题 - 修复了多语言会话中 agent 会话错误的问题 @@ -738,7 +738,7 @@ noindex: true ## 改进 - * Workflows 现在支持每天最多运行 50 次，高于此前的 20 次。 + * Automations 现在支持每天最多运行 50 次，高于此前的 20 次。 * 现在可在 API 操作台中支持[完整 base URL](/zh/organize/settings-api)，方法是在 `docs.json` 中配置 `api.url`。 * 控制台布局已更新，改进了导航以及编辑器和设置页面的侧边栏访问体验。 * 编辑器搜索栏已重新设计，优化了查找和跳转到文件的用户体验。 @@ -756,12 +756,12 @@ noindex: true * 修复了输入字段在移动端的缩放行为。 - - ## Workflows + + ## Automations - 使用[workflows](/automations)自动化文档相关任务。你可以配置定时或事件触发的自动化流程，由 agent 运行以更新你的文档。 + 使用[automations](/zh/automations)自动化文档相关任务。你可以配置定时或事件触发的自动化流程，由 agent 运行以更新你的文档。 - Workflows 目前处于测试阶段，所有套餐均可使用。 + Automations 目前处于测试阶段，所有套餐均可使用。 ## 评论与建议 diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index 4e3e4965f..6c02591eb 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -81,7 +81,7 @@ mint status ## `mint workflow`
-从终端创建、列出和删除[工作流](/automations)。需要使用 `mint login` 进行身份验证。 +从终端创建、列出和删除[自动化](/zh/automations)。需要使用 `mint login` 进行身份验证。 ```bash mint workflow [flags] diff --git a/zh/dashboard/audit-logs.mdx b/zh/dashboard/audit-logs.mdx index 24ff2bfe9..c86cc848a 100644 --- a/zh/dashboard/audit-logs.mdx +++ b/zh/dashboard/audit-logs.mdx @@ -55,7 +55,7 @@ keywords: ["monitoring", "activity tracking", "security", "compliance"] | Billing | 订阅更新、附加组件购买和发票查看。 | | Quota | 超额策略和告警配置更改。 | | User | 个人用户通知设置。 | -| Workflows | 工作流配置和存储库管理。 | +| Automations | 自动化配置和存储库管理。 | | Audit log | 审计日志的查看和导出。 | | Auth | 登录尝试、登出和会话创建。 | diff --git a/zh/guides/configure-automerge.mdx b/zh/guides/configure-automerge.mdx index 547dca74d..66e15551d 100644 --- a/zh/guides/configure-automerge.mdx +++ b/zh/guides/configure-automerge.mdx @@ -1,14 +1,14 @@ --- title: "配置 GitHub 应用的自动合并" sidebarTitle: "配置自动合并" -description: "通过将 Mintlify 机器人添加到仓库规则集的绕过列表，设置 GitHub 工作流程以自动合并 Mintlify pull request。" +description: "通过将 Mintlify 机器人添加到仓库规则集的绕过列表，设置 GitHub 工作流以自动合并 Mintlify pull request。" keywords: ["automerge", "ruleset", "分支保护", "bypass"] --- -将 Mintlify GitHub 应用添加到规则集的绕过列表中，使该应用能够创建和合并 pull request 而审查和状态检查要求不会阻止它。这允许你配置[工作流程](/automations/index)以自动将更改合并到 `main`。 +将 Mintlify GitHub 应用添加到规则集的绕过列表中，使该应用能够创建和合并 pull request 而审查和状态检查要求不会阻止它。这允许你配置[自动化](/zh/automations/index)以自动将更改合并到 `main`。 - Mintlify GitHub 应用必须对**所有**针对你部署分支的规则集都拥有绕过权限，包括在组织级和仓库级定义的规则集。如果任何规则集缺少绕过条目，工作流程会创建 PR，但不会将其合并。 + Mintlify GitHub 应用必须对**所有**针对你部署分支的规则集都拥有绕过权限，包括在组织级和仓库级定义的规则集。如果任何规则集缺少绕过条目，自动化会创建 PR，但不会将其合并。
@@ -51,4 +51,4 @@ keywords: ["automerge", "ruleset", "分支保护", "bypass"]
1. **对于贡献者**：打开一个针对 `main` 的 PR。确认它仍然需要批准和通过状态检查后你才能合并。 -2. **对于工作流程**：触发启用了自动合并的工作流程。确认工作流程运行并成功合并 PR。 +2. **对于自动化**：触发启用了自动合并的自动化。确认自动化运行并成功合并 PR。 diff --git a/zh/guides/improving-docs.mdx b/zh/guides/improving-docs.mdx index 78dcbeb49..890f44239 100644 --- a/zh/guides/improving-docs.mdx +++ b/zh/guides/improving-docs.mdx @@ -123,7 +123,7 @@ Mintlify 的分析功能让你可以将反馈评分与流量数据一起查看 - **专注于关键用户旅程。** 确定对你产品成功最关键的三到五个任务，并确保支持这些任务的文档在你担心其他内容之前是出色的。 - 使用[工作流](/automations)来自动化重复性改进——例如为被低反馈评分标记的页面打开包含建议修复的拉取请求。 + 使用[自动化](/zh/automations)来自动处理重复性改进——例如为被低反馈评分标记的页面打开包含建议修复的拉取请求。
diff --git a/zh/guides/index.mdx b/zh/guides/index.mdx index f4c3c2185..4afaa61f5 100644 --- a/zh/guides/index.mdx +++ b/zh/guides/index.mdx @@ -19,8 +19,8 @@ boost: 3 使用 AI 驱动的工具加速你的文档工作流程。 * [构建应用内 AI 助手](/zh/guides/assistant-embed)：教程，讲解如何在 React 应用中添加 AI 聊天机器人，帮助用户从你的文档中找到答案。 -* [配置自动合并](/zh/guides/configure-automerge)：将 Mintlify GitHub 应用添加到规则集的绕过列表中，以启用工作流程的自动合并。 -* [使用工作流](/guides/use-automations)：选择合适的工作流触发器、撰写有效的指令，并从自动化的内容维护中获得一致的结果。 +* [配置自动合并](/zh/guides/configure-automerge)：将 Mintlify GitHub 应用添加到规则集的绕过列表中，以为自动化启用自动合并。 +* [使用自动化](/zh/guides/use-automations)：选择合适的自动化触发器、撰写有效的指令，并从自动化的内容维护中获得一致的结果。 * [Claude Code](/zh/guides/claude-code)、[Cursor](/zh/guides/cursor)、[Windsurf](/zh/guides/windsurf)：使用 AI 编程助手维护文档的指南。 * [GEO](/zh/guides/geo)：为 AI 搜索和问答引擎优化文档的最佳实践。 diff --git a/zh/guides/internationalization.mdx b/zh/guides/internationalization.mdx index caa3fefbb..dd243183d 100644 --- a/zh/guides/internationalization.mdx +++ b/zh/guides/internationalization.mdx @@ -326,7 +326,7 @@ docs/ ### 自动化翻译
-如需自动化翻译解决方案，[设置工作流](/automations)，让代理按计划运行或在仓库推送时触发。 +如需自动化翻译解决方案，[设置自动化](/zh/automations)，让代理按计划运行或在仓库推送时触发。
### 外部翻译服务商 diff --git a/zh/guides/maintenance.mdx b/zh/guides/maintenance.mdx index 74e4e7ccb..df38caf86 100644 --- a/zh/guides/maintenance.mdx +++ b/zh/guides/maintenance.mdx @@ -62,7 +62,7 @@ keywords: ["文档维护", "保持文档更新", "内容生命周期", "过时 - 使用 [CI 检查](/zh/deploy/ci)在每个 pull request 中强制执行 frontmatter 要求并捕获损坏的链接 - 使用 [workflows](/automations) 按计划运行自动化维护检查——标记过时内容、检查缺失的元数据，或发现反馈评分持续偏低的页面。 + 使用 [automations](/zh/automations) 按计划运行自动化维护检查——标记过时内容、检查缺失的元数据，或发现反馈评分持续偏低的页面。
diff --git a/zh/guides/navigation.mdx b/zh/guides/navigation.mdx index 5beb5b8bb..caa12992a 100644 --- a/zh/guides/navigation.mdx +++ b/zh/guides/navigation.mdx @@ -149,7 +149,7 @@ keywords: ["文档导航", "信息架构", "文档结构", "侧边栏导航", " - **每年重新审视顶级结构。** 随着文档的增长，在 20 个页面时有效的方式在 200 个页面时可能不再适用。 - 使用 [workflows](/automations) 来自动化定期检查，例如识别反馈评分低的页面或标记很少被点击的导航项目。 + 使用 [automations](/zh/automations) 来自动化定期检查，例如识别反馈评分低的页面或标记很少被点击的导航项目。 要在 Mintlify 中配置导航——选项卡、分组、锚点和页面排序——请参阅[导航参考](/zh/organize/navigation)。 diff --git a/zh/guides/seo.mdx b/zh/guides/seo.mdx index 447cdd858..c400bc139 100644 --- a/zh/guides/seo.mdx +++ b/zh/guides/seo.mdx @@ -148,7 +148,7 @@ Mintlify 负责多项技术 SEO 基础工作： - 发布前使用 `mint broken-links` 检查损坏的链接 - 使用 [workflows](/automations) 来自动化 SEO 维护任务。 + 使用 [automations](/zh/automations) 来自动化 SEO 维护任务。 过时的文档会在 SEO 之外产生第二个问题：如果用户通过搜索找到你的页面但信息是错误的，他们会对你的文档失去信任。 diff --git a/zh/guides/style-and-tone.mdx b/zh/guides/style-and-tone.mdx index 5dcbbe5c9..0b33d157a 100644 --- a/zh/guides/style-and-tone.mdx +++ b/zh/guides/style-and-tone.mdx @@ -145,7 +145,7 @@ keywords: ["技术写作", "文档风格指南", "写作规范", "语气与文 - **现有风格指南：** 与其从头编写规则，不如从已有的指南开始。[Google Developer Documentation Style Guide](https://developers.google.com/style)、[Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) 和 [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse) 都是免费且广泛使用的。 - 使用 [workflow](/automations) 按计划运行风格审核，或在每次向文档仓库推送更改时运行。 + 使用 [automation](/zh/automations) 按计划运行风格审核，或在每次向文档仓库推送更改时运行。
diff --git a/zh/guides/use-automations.mdx b/zh/guides/use-automations.mdx new file mode 100644 index 000000000..0e8b0f4a6 --- /dev/null +++ b/zh/guides/use-automations.mdx @@ -0,0 +1,126 @@ +--- +title: "使用自动化" +description: "使用 Mintlify 自动化来自动执行周期性的文档维护：选择合适的触发器、撰写有效的指令，并获得一致的 agent 结果。" +keywords: ["automations", "automation", "automate", "automation guide", "automation instructions", "agent automation", "self updating"] +--- + +自动化会自动运行 agent，让你的内容无需手动维护就能保持准确。本指南介绍如何选择合适的自动化、有效地配置它，以及撰写能产生一致结果的指令。 + +
+ ## 何时使用自动化 +
+ +自动化最适合以下任务： + +- **重复性**：相同任务定期在可预测的计划下运行，或每当特定事件发生时运行。 +- **耗时**：手动完成需要时间但遵循一致模式的任务。 +- **响应式**：应在代码或内容变更时自动发生的任务，例如在功能发布后更新文档。 + +对于一次性或探索性任务，请直接在[控制台](https://app.mintlify.com)或 Slack 中使用 agent。 + +
+ ## 选择触发器 +
+ +每个自动化都基于三种触发器类型之一运行。选择与你需要的工作完成时机相匹配的触发器。 + +| 触发器 | 使用场景 | +|---|---| +| 内容更新（Content update） | 任务应在你的项目内容变更时运行——翻译新页面、修复失效链接或审计 SEO 元数据。 | +| 代码变更（Code change） | 任务应在源代码变更时运行——在 PR 合并后更新 API 规范或文档。 | +| 自定义计划（Custom schedule） | 任务应按固定节奏运行——发布每周更新日志或运行定期的语法检查。 | + +
+ ## 预定义自动化 +
+ +Mintlify 为最常见的内容维护任务提供了预定义自动化。在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面打开其中任何一个。 + +详情请参见[预定义自动化](/zh/automations/reference)。 + +
+ ## 自定义自动化 +
+ +为预定义选项未涵盖的任务创建自定义自动化。自定义自动化让你完全控制触发器、指令和上下文仓库。 + +设置步骤请参见[创建自定义自动化](/zh/automations/create)。 + +
+ ### 撰写有效的指令 +
+ +自定义自动化指令是 agent 每次运行时遵循的提示词。指令的质量直接影响结果的一致性。 + +**描述结果，而不仅仅是任务。** 告诉 agent 完成后是什么样子。 + + +```text Less effective +Review the API reference pages. +``` + +```text More effective +Review every page in the /api-reference directory. For each endpoint, confirm that the request parameters, response fields, and example payloads match the OpenAPI spec in the api/openapi.yaml file. Open a pull request with corrections for any discrepancies you find. +``` + + +**撰写流程。** Agent 遵循按步骤指令比开放式提示词更可靠。 + +```text Example procedure +1. Read the merged pull request diff from the trigger repository. +2. Identify any changed API endpoints, parameters, or response shapes. +3. Search the documentation for pages that reference those endpoints. +4. Update the affected pages to match the changes in the pull request. +5. Open a pull request with a summary of the pages you changed and why. +``` + +**保持范围窄。** 一个把单一事情做好的自动化，比一个试图做许多事情的自动化更可靠。将复杂任务拆分到多个自动化中。 + +**指定文件和目录。** 你对 agent 应查看的位置越精确，它花在搜索上的时间就越少。 + +```text Example with specific paths +Check every MDX file in the /content directory for broken internal links (links beginning with /). +For each broken link, either fix the path or remove the link if no replacement exists. +``` + +
+ ### 使用上下文仓库 +
+ +对于自定义自动化和部分预定义自动化，你可以添加自动化运行时 agent 会读取的上下文仓库。 + +在以下情况添加上下文仓库： +- 你的内容引用了存放在独立仓库中的代码、API 或配置。 +- 你希望 agent 在决定要更新什么时，将你的内容与源代码进行对比。 +- 自动化提示词引用了 Mintlify 项目仓库之外的文件。 + +每个自动化最多可添加 10 个上下文仓库。 + +
+ ### 更新模式 +
+ +决定在更改上线前你希望进行多少审查。 + +- **自动（Automatic）**：更改直接合并到你的 Mintlify 项目仓库，无需审查。适用于低风险、高频任务，如翻译、语法检查和链接修复。 +- **要求审查（Require review）**：agent 打开 pull request，由人工审查后再合并。适用于会改变内容含义的任务，如与代码变更同步或更新 API 参考。 + +
+ ## 控制积分使用量 +
+ +每次自动化运行都会消耗积分。例如，大多数 **update from code changes** 自动化运行会消耗 40 到 180 积分。更新许多页面的复杂运行会消耗更多积分。 + +为 cron 任务安排在特定时间运行可以让你更精确地控制积分使用量。例如，让自动化每天或每周运行一次，就可以确切了解它每月会创建多少 pull request。基于推送触发的自动化在每月之间可能差异更大，因为它们取决于内容或代码变更的频率。 + +
+ ## 审查并改进自动化结果 +
+ +自动化是自动运行的，但定期审查会有帮助。 + +1. 打开 [Automations](https://app.mintlify.com/products/automations) 页面上的 **Runs** 选项卡，查看最近的运行历史和状态。 +2. 点击某次运行以阅读 agent 的摘要，并审查它打开的任何 pull request。 +3. 如果结果不一致，请优化你的指令：添加更具体的流程、缩小文件范围或将自动化拆分为更小的任务。 + +启用新自动化后，通常进行几个审查周期就足以微调指令。 diff --git a/zh/organize/navigation.mdx b/zh/organize/navigation.mdx index 89d3e00dc..0884e7618 100644 --- a/zh/organize/navigation.mdx +++ b/zh/organize/navigation.mdx @@ -783,7 +783,7 @@ Mintlify 使用 `versions` 数组中的第一个版本作为默认版本。使 } ``` -如需自动翻译，[设置工作流](/automations)，让代理按计划运行或在仓库推送时触发。 +如需自动翻译，[设置自动化](/zh/automations)，让代理按计划运行或在仓库推送时触发。
diff --git a/zh/what-is-mintlify.mdx b/zh/what-is-mintlify.mdx index a992fcb20..6f337e241 100644 --- a/zh/what-is-mintlify.mdx +++ b/zh/what-is-mintlify.mdx @@ -43,7 +43,7 @@ flowchart LR **AI 助手**让你的用户可以提问，并从你的内容中获得带引用的回答。 -**Agent** 可以根据计划的工作流、合并到功能存储库的拉取请求 (PR；亦称“合并请求”/Merge Request) 或 Slack 线程生成更新，从而帮助你的团队创建和维护内容。 +**Agent** 可以根据计划的自动化、合并到功能存储库的拉取请求 (PR；亦称“合并请求”/Merge Request) 或 Slack 线程生成更新，从而帮助你的团队创建和维护内容。 参见 [AI 原生文档](/zh/ai-native) 了解所有 AI 功能的概览。