Usar automatizaciones

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.

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 o desde Slack.

Cada automatización se ejecuta con uno de cuatro tipos de activadores. Elige el que se ajuste a cuándo necesitas que se realice el trabajo.

Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de contenido más comunes. Activa cualquiera de ellas desde la página Automatizaciones de tu dashboard.

Consulta Automatizaciones predefinidas para más detalles.

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 para los pasos de configuración.

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”.

Review the API reference pages.

Escribe un procedimiento. Los agentes siguen las instrucciones paso a paso con más fiabilidad que los prompts abiertos.

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.

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.

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.

Decide cuánta revisión deseas antes de que los cambios se publiquen.

• Update and merge changes: 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.
• Modify and wait for review: 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.

Cada ejecución de una automatización que actualiza tu documentación cuesta 250 créditos, sin importar cuánto contenido lee el agente o cuántas páginas cambia. Las ejecuciones que no encuentran nada que actualizar no cuestan nada. Para ver cuántos créditos usan tus automatizaciones, consulta el registro de actividad en la página de Uso.

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 limitar cuántas actualizaciones puede hacer al mes. Una programación también agrupa varios cambios de origen en una sola actualización, de modo que no pagas por cada cambio por separado. 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.

Las automatizaciones se ejecutan automáticamente, pero se benefician de revisiones periódicas.

1. Abre la pestaña Runs en la página Automatizaciones para ver el historial reciente de ejecuciones y su estado.
2. Para ver más información sobre una ejecución, haz clic en el botón del menú de acciones y selecciona View run details para ver el prompt, el resumen, los archivos y la pull request.
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.