-
Notifications
You must be signed in to change notification settings - Fork 234
docs: translate workflows updates to es and fr #6034
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| --- | ||
| title: "Usar workflows" | ||
| description: "Aprende a usar los workflows de Mintlify para automatizar tareas recurrentes de mantenimiento de contenido, elige el tipo de trigger adecuado, escribe instrucciones efectivas y obtén resultados consistentes." | ||
| 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. | ||
|
|
||
| <div id="when-to-use-workflows"> | ||
| ## Cuándo usar workflows | ||
| </div> | ||
|
|
||
| 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. | ||
|
|
||
| <div id="choose-a-trigger"> | ||
| ## Elegir un trigger | ||
| </div> | ||
|
|
||
| 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. | | ||
|
|
||
| <div id="predefined-workflows"> | ||
| ## Workflows predefinidos | ||
| </div> | ||
|
|
||
| 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. | ||
|
|
||
| <div id="custom-workflows"> | ||
| ## Workflows personalizados | ||
| </div> | ||
|
|
||
| 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. | ||
|
|
||
| <div id="write-effective-instructions"> | ||
| ### Escribir instrucciones efectivas | ||
| </div> | ||
|
|
||
| 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. | ||
|
|
||
| <CodeGroup> | ||
| ```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. | ||
| ``` | ||
| </CodeGroup> | ||
|
|
||
| **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. | ||
| ``` | ||
|
|
||
| <div id="use-context-repositories"> | ||
| ### Usar repositorios de contexto | ||
| </div> | ||
|
|
||
| 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. | ||
|
|
||
| <div id="update-mode"> | ||
| ### Modo de actualización | ||
| </div> | ||
|
|
||
| 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. | ||
|
|
||
| <div id="control-credit-usage"> | ||
| ## Controlar el uso de créditos | ||
| </div> | ||
|
|
||
| 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. | ||
|
|
||
| <div id="review-and-improve-workflow-results"> | ||
| ## Revisar y mejorar los resultados de los workflows | ||
| </div> | ||
|
|
||
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| 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 el agente para automatizar tareas de documentación recurrentes." | ||
| keywords: ["automatización", "automatizar", "cron", "agente", "workflow personalizado"] | ||
| --- | ||
|
|
||
| import GitlabWorkflowSetup from '/snippets/es/gitlab-workflow-setup.mdx'; | ||
|
|
||
| <div id="prerequisites"> | ||
| ## Requisitos previos | ||
| </div> | ||
|
|
||
| - 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) | ||
|
|
||
| <div id="create-a-custom-workflow"> | ||
| ## Crear un workflow personalizado | ||
| </div> | ||
|
|
||
| <Note> | ||
| 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. | ||
| </Note> | ||
|
|
||
| 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 y el modo de actualización. | ||
| 4. Haz clic en **Create workflow**. | ||
|
|
||
| <div id="write-effective-instructions"> | ||
| ## Escribir instrucciones efectivas | ||
| </div> | ||
|
|
||
| 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). | ||
|
|
||
| <Tip> | ||
| Revisa la salida de tus workflows personalizados para confirmar que funcionan como se espera. Actualiza tus instrucciones para mejorar los resultados. | ||
| </Tip> | ||
|
|
||
| <GitlabWorkflowSetup /> | ||
|
|
||
| <div id="delete-a-custom-workflow"> | ||
| ## Eliminar un workflow personalizado | ||
| </div> | ||
|
|
||
| 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 <Icon icon="settings" /> de configuración junto a un workflow. | ||
| 3. Haz clic en **Delete**. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Workflow pages missing from locale navigation configs
High Severity
This PR creates four workflow pages per locale (
es/workflows/index.mdx,reference.mdx,manage.mdx,create.mdxand the same forfr/) but never adds a corresponding Workflows navigation group toes.jsonorfr.json. The Englishdocs.jsonhas a dedicated Workflows group with all four pages, so these locale pages are orphaned — unreachable from the sidebar. Internal links throughout the new content (e.g./es/workflows/reference,/es/workflows/create) land on pages with no navigation context. The Agent group in both locale configs also still listsagent/workflowsinstead ofagent/use-casesas in the English structure.Additional Locations (1)
fr.json#L80-L90Reviewed by Cursor Bugbot for commit 14c3bc4. Configure here.