Puedes permitir que el agente sugiera actualizaciones de la documentación a partir de dos fuentes:
- Cambios en solicitudes de extracción (pull requests): Supervisa repositorios de Git seleccionados para detectar cambios de código que requieran actualizaciones en la documentación.
- Conversaciones con el assistant: Analiza las preguntas que los usuarios hacen al assistant en tu sitio de documentación para identificar lagunas de contenido.
Cuando el agente identifica posibles actualizaciones de la documentación, crea una sugerencia en tu dashboard con el contexto necesario para crear una solicitud de extracción.
Usa las sugerencias para mantener tu documentación actualizada de forma proactiva cuando se lancen nuevas funciones o para abordar preguntas frecuentes de los usuarios.
Antes de usar las sugerencias, debes instalar la Aplicación de GitHub de Mintlify en tu organización. La aplicación debe tener acceso a tu repositorio de documentación y al menos a otro repositorio donde los cambios en el código requieran actualizaciones en la documentación.
Configura qué repositorios supervisa el agente y cómo quieres recibir las notificaciones en la configuración del agente. La página de configuración muestra todas las organizaciones y repositorios de GitHub que el agente supervisa.
Para acceder a la configuración del agente:
-
Haz clic en el botón Ask agent en tu dashboard para abrir el panel del agente.
-
Haz clic en el botón Settings.
El agente supervisa todas las solicitudes de extracción fusionadas para cada repositorio que habilites, sin importar en qué branch se fusionen. Se ejecuta una verificación de GitHub llamada Mintlify Autopilot en las solicitudes de extracción de los repositorios supervisados para analizarlas en busca de posibles actualizaciones de documentación. Cuando fusionas una solicitud de extracción que requiere actualizaciones de documentación, el agente crea una sugerencia en tu dashboard.
Cuando habilitas por primera vez la supervisión de un repositorio, el agente crea sugerencias para las solicitudes de extracción fusionadas en los últimos siete días. Este proceso retroactivo solo ocurre si aún no existen sugerencias para ese repositorio. Es posible que veas aparecer varias sugerencias inmediatamente después de habilitar la supervisión.
Si desactivas la supervisión, el agente deja de supervisar el repositorio de inmediato. Cualquier sugerencia existente para ese repositorio permanece en tu dashboard hasta que las descartes.
Si tienes acceso al agente y al assistant, el agente genera sugerencias a partir de las conversaciones que tus usuarios tienen con el assistant.
El agente analiza periódicamente las conversaciones del assistant y crea sugerencias cuando identifica patrones de preguntas que indican que falta documentación o que esta no es clara.
Las sugerencias del agente siempre aparecen en tu dashboard. Puedes configurar las notificaciones para recibir correos electrónicos o mensajes directos de Slack cuando el agente cree nuevas sugerencias.
Si no recibes notificaciones por correo electrónico para las sugerencias, revisa tu carpeta de correo no deseado y agrega la dirección de correo notifications@mintlify.com a tu lista de remitentes seguros.
El agente crea sugerencias en tu dashboard. Cada sugerencia muestra la solicitud de extracción o el tema de conversación del assistant que generó la sugerencia, la fecha de creación y las actualizaciones de documentación propuestas.
El botón Ask agent en tu dashboard muestra el número de sugerencias que están esperando tu revisión.
Añade sugerencias como contexto para que el agente cree solicitudes de extracción.
- Haz clic en el botón Ask agent en tu dashboard para abrir el panel del agente.
- Haz clic en Add to chat.
- Envía el mensaje al agente para abrir una solicitud de extracción.
Si una sugerencia no requiere actualizaciones en la documentación o ya has aplicado los cambios, descártala para eliminarla de tu dashboard.
- Haz clic en el botón Ask agent en tu dashboard para abrir el panel del agente.
- Haz clic en el botón Dismiss junto a cualquier sugerencia que desees descartar.
La sugerencia se elimina inmediatamente de tu dashboard. No puedes recuperar las sugerencias descartadas.