Si el propietario de tu espacio de trabajo de Slack requiere aprobación de administrador para instalar aplicaciones, pídele que apruebe la aplicación de Mintlify antes de conectarla.
Conecta tu espacio de trabajo de Slack
- Ve a la página de Agent en tu dashboard.
- En la sección “Agent settings”, haz clic en Install Slack app.
- Sigue las indicaciones de Slack para instalar la app
mintlifyen tu espacio de trabajo. - Sigue las indicaciones de Slack para vincular tu cuenta de Mintlify con tu espacio de trabajo de Slack.
- Verifica que el agente esté funcionando y responda cuando:
- Le envíes un mensaje directo al agente.
- Menciones al agente con
@mintlifyen un canal.
Cada espacio de trabajo de Slack solo puede conectarse a una organización de Mintlify a la vez. Si intentas instalar el agente en un espacio de trabajo que ya está conectado a otra organización, la instalación fallará con un error de «wrong organization». Desinstala primero la app de la otra organización, o utiliza un espacio de trabajo de Slack diferente.Puedes instalar el agente de Slack incluso si no tienes un proyecto alojado en Mintlify. El agente sigue funcionando para responder preguntas y mantener conversaciones. Las funciones que abren pull requests requieren un repositorio conectado.
El agente de Slack no está disponible para proyectos en Bitbucket Cloud.Si tu proveedor Git está detrás de una lista de IPs permitidas, autoriza la IP de salida
54.242.90.151 de Mintlify para que el agente pueda clonar tu repositorio. Contacta con soporte para activarlo.Desconectar el agente
- Abre la página Automatizaciones en tu dashboard.
- Haz clic en Disconnect Slack para revocar la conexión entre Mintlify y tu workspace.
- En Slack, abre Settings & administration > Manage apps, busca la aplicación
mintlifyy haz clic en Remove.
Reconectar o reinstalar el agente
Usar el agente en Slack
- Enviar mensajes directos al agente para usarlo en privado y actualizar tu documentación.
- Mencionar
@mintlifyen un canal para usarlo de forma pública y colaborativa. - Adjuntar archivos e imágenes directamente a tus mensajes para que el agente los procese y los incluya en tu documentación.
- Continuar las conversaciones en hilos para iterar sobre los cambios o hacer preguntas de seguimiento. El agente reutiliza los archivos, las imágenes y las reacciones con emoji compartidos previamente en el hilo como contexto para las solicitudes posteriores, por lo que no es necesario que los vuelvas a cargar.
- Compartir enlaces a solicitudes de extracción con el agente para actualizar la documentación relacionada.
Haz preguntas sobre tu documentación
- Nueva pregunta: Envía un mensaje directo al agente o menciona
@mintlifyen un canal con tu pregunta. - Hilo existente: Responde en el hilo y menciona
@mintlifycon una pregunta de seguimiento.
- «¿Qué páginas mencionan el límite de tasa de la API?»
- «¿Cómo configuro la autenticación?»
- «¿Cómo está estructurada nuestra navegación?»
Usar integraciones conectadas
- Las integraciones compartidas están disponibles para toda la organización.
- Las integraciones personales usan la cuenta conectada por el miembro que está hablando con el agente.
Actualizar la documentación
- Nueva solicitud: Envía un mensaje directo al agente o menciona
@mintlifyen un canal con instrucciones sobre qué actualizar. - Hilo existente: Responde en el hilo y menciona
@mintlifycon instrucciones sobre qué actualizar. - Con archivos adjuntos: Sube imágenes, diagramas, PDFs, SVGs, archivos de código u otros documentos junto con tu mensaje. El agente los procesa automáticamente y los incluye en tu documentación. En un hilo, el agente tiene acceso a las imágenes y archivos compartidos en mensajes anteriores, por lo que puedes hacer referencia a ellos en las solicitudes posteriores sin necesidad de volver a subirlos.
staging» o «envía estos commits a docs-refresh». El agente crea la solicitud de extracción contra el branch que indiques, o envía commits directamente a él cuando ese branch ya existe.
Continuar la ejecución de una automatización
@mintlify para continuar el trabajo. El agente recoge todo el contexto de la ejecución, hace checkout del mismo branch y publica los cambios que solicites como commits de seguimiento en la misma solicitud de extracción, en lugar de abrir una nueva.
También puedes compartir un enlace a cualquier solicitud de extracción de Mintlify directamente con el agente para continuarla desde un nuevo hilo.
Cuando una automatización de cambios de código abre una solicitud de extracción de documentación, publica un comentario en la solicitud de extracción de código que la desencadenó, enlazando a la solicitud de extracción de documentación que creó, y asigna un revisor probando en orden al autor y los committers de la solicitud de extracción de código hasta que uno acepte.
Gestionar automatizaciones
- «Crea una automatización que redacte una entrada del changelog cada vez que fusionemos en main.»
- «Configura una automatización que actualice la documentación cada vez que se cierre una incidencia de Jira.»
- «Desactiva la automatización semanal del changelog.»
- «Ejecuta la automatización de cambios de código sobre la PR #123.»
- «Revisa las fusiones del último mes y actualiza el changelog.»
- «¿Cómo puedo hacer que mis automatizaciones sean más eficientes en el uso de créditos?»
- «¿Por qué falló la última ejecución de la automatización de cambios de código?»
Activar automatizaciones desde mensajes de Slack
Puedes configurar una automatización personalizada para que se ejecute cuando alguien publique un mensaje de nivel superior en un canal de Slack elegido. El agente lee cada mensaje, decide si justifica una actualización de la documentación y abre una solicitud de extracción cuando corresponde. Configúralo cuando crees o edites la automatización en la página Automatizaciones. La appmintlify debe ser miembro del canal que elijas. Invítala con /invite @mintlify antes de guardar la automatización.
Hacer referencia a otros repositorios
- “Actualiza la guía de autenticación según los cambios en
acme/api-server/src/auth.ts.” - “Documenta los nuevos endpoints añadidos en
acme/backend#1234.” - “¿A qué repositorios tienes acceso?”
Sigue el progreso en tiempo real
- Actualizaciones de estado: Un mensaje que se actualiza en vivo muestra lo que el agente está haciendo, como cuántos archivos ha buscado, leído y editado.
- Progreso de las tareas: Cuando el agente divide tu solicitud en varias tareas, muestra una lista de verificación para que puedas seguir el progreso de cada una.
- Preguntas: Si el agente necesita más información, presenta opciones para que selecciones o respondas en el hilo con una respuesta personalizada.
- Interrupciones: Si envías un mensaje de seguimiento mientras el agente aún está trabajando, detiene la tarea actual y comienza con la nueva.
- Finalización: Cuando el agente termina, publica un resumen con un enlace a la solicitud de extracción o al commit y un enlace para abrir los cambios en el editor web.
Roles y permisos
- Administradores y editores: Pueden hacer preguntas y aplicar cambios en la documentación. El agente tiene acceso a las herramientas de edición de archivos y de pull requests.
- Lectores: Solo pueden hacer preguntas. El agente siempre se ejecuta en modo de solo lectura para las herramientas de Mintlify, independientemente de la solicitud.
Usar el agente en el panel lateral de Slack
Chatea con@mintlify en el panel lateral de Slack para hacer preguntas o solicitar actualizaciones de la documentación sin publicar en un canal. El agente del panel lateral se comporta como el agente de Slack: mismos permisos, mismas herramientas y el mismo proceso de revisión para los cambios que realiza.
Mejores prácticas
- Sé específico: Indícale al agente exactamente qué quieres documentar y dónde debe ir.
- Añade contexto: Si un hilo no contiene toda la información necesaria, incluye detalles adicionales en tu mensaje al agente.
- Revisa cuidadosamente: Siempre debes revisar las solicitudes de extracción que genere el agente antes de fusionarlas.