DevDocs: una herramienta de código abierto para rastrear y procesar documentación, diseñada para programadores 75

小编 ·

DevDocs: una herramienta de código abierto para rastrear y procesar documentación, diseñada para programadores

DevDocs es una herramienta de código abierto para la gestión de documentación técnica, diseñada por CyberAGI Inc para programadores. Admite el rastreo inteligente de documentación técnica, permite personalizar la profundidad del rastreo, descubre y clasifica automáticamente contenido relacionado, extrae información limpia y permite exportarla en formato MD o JSON, reduciendo el tiempo necesario para entender la documentación de semanas a horas. Además, DevDocs incluye un servidor MCP integrado, lo que permite integrarlo con aplicaciones de IA como Claude, Cursor y Cline para realizar consultas sobre la documentación mediante chat.

DevDocs: una herramienta de código abierto para rastrear y procesar documentación, diseñada para programadores

¿Qué es DevDocs?

DevDocs es una herramienta de gestión de documentación técnica de código abierto diseñada por CyberAGI Inc específicamente para programadores. Admite el rastreo inteligente de documentación técnica, permite personalizar la profundidad del rastreo, descubre y clasifica automáticamente el contenido relacionado, extrae información limpia y admite la exportación en formato MD o JSON, reduciendo el tiempo que solía llevar semanas para entender la documentación a solo unas horas. Además, DevDocs incluye un servidor MCP integrado, que permite la integración con aplicaciones de IA como Claude, Cursor, Cline, etc., para consultar documentación mediante conversaciones de chat.

DevDocs:一款专为程序员打造的开源文档爬取和处理工具.webp

Características de DevDocs

Rastreo inteligente:

  • Admite la selección de la profundidad de rastreo (niveles 1-5).

  • Descubre y clasifica automáticamente todas las páginas relacionadas.

  • Rastreo selectivo, extrayendo con precisión el contenido necesario.

  • Detecta y mapea automáticamente las sub-URL dentro de la estructura del sitio web.

Rendimiento y velocidad:

  • Soporta procesamiento paralelo, rastreando múltiples páginas simultáneamente.

  • Caché inteligente para evitar el rastreo repetido de contenido.

  • Soporta carga diferida (lazy loading), compatible con aplicaciones web modernas.

  • Respeta al servidor, con límites de velocidad de rastreo configurados.

Procesamiento de contenido:

  • Extrae contenido limpio, eliminando información irrelevante.

  • Soporta exportación en formato MD o JSON, conveniente para el ajuste fino de LLM.

  • Organiza el contenido de forma lógica, facilitando su comprensión y uso.

  • Integración con el servidor MCP, utilizable directamente para procesamiento de IA.

Funciones empresariales:

  • Reintento automático en caso de fallo del rastreo.

  • Registro completo de operaciones en logs.

  • Proporciona una interfaz API para facilitar la integración con otras herramientas.

  • Soporta gestión de equipos, con múltiples asientos y roles configurables.

DevDocs:一款专为程序员打造的开源文档爬取和处理工具.webp

Tutorial de uso de DevDocs

Iniciar el servicio:

  • Usando Docker (recomendado):

  • Clonar el repositorio del proyecto: git clone https://github.com/cyberagiinc/DevDocs.git

  • Entrar al directorio del proyecto: cd DevDocs

  • Ejecutar el script de inicio según el sistema operativo:

  • Mac/Linux: ./docker-start.sh

  • Windows: docker-start.bat

  • Configuración manual de permisos (los usuarios de Windows pueden necesitarla):

  • A través del Explorador de Windows:

  1. Haga clic derecho en los directorios logs, storage, crawl_results.

  2. Seleccione "Propiedades".

  3. Vaya a la pestaña "Seguridad".

  4. Haga clic en "Editar" para cambiar los permisos.

  5. Haga clic en "Agregar" para añadir un usuario o grupo.

  6. Escriba "Everyone" y haga clic en "Comprobar nombres".

  7. Haga clic en "Aceptar".

  8. Seleccione "Everyone" en la lista.

  9. Marque "Control total" bajo "Permitir".

  10. Haga clic en "Aplicar" y luego en "Aceptar".

A través del símbolo del sistema (ejecutar como administrador):

icacls logs /grant Everyone:F /T
icacls storage /grant Everyone:F /T
icacls crawl_results /grant Everyone:F /T

Acceder a DevDocs:

  • Interfaz de usuario (frontend): http://localhost:3001

  • API del backend: http://localhost:24125

  • Servicio Crawl4AI: http://localhost:11235

Ver registros (logs):

  • Cuando se usa Docker, puede ver los registros del contenedor con los siguientes comandos:

  • Ver registros de un contenedor específico: docker logs devdocs-frontend, docker logs devdocs-backend, docker logs devdocs-mcp, docker logs devdocs-crawl4ai

  • Seguimiento de logs en tiempo real: docker logs -f devdocs-backend

Detener el servicio:

Presione Ctrl+C en la terminal donde se está ejecutando docker-start.

Cómo integrar con Cline/Roo

1. Crear un modo:

  • Abra la interfaz "Modos" en Roo Code y haga clic en el signo + para crear un nuevo prompt específico para el modo.

2. Nombre el modo (por ejemplo, Research_MCP).

3. Defina el rol:

  • Experiencia: recuperación de documentación para desarrolladores, síntesis técnica y búsqueda de documentación.

  • Personalidad: sistemática, detallista y precisa.

  • Instrucciones de comportamiento: use siempre las herramientas de acceso al índice y a las secciones para responder consultas sobre la documentación MCP.

4. Instrucciones personalizadas:

  • Herramienta de índice: devuelve una lista completa o filtrada de temas de documentación.

  • Herramienta de acceso a secciones: recupera contenido detallado de secciones específicas de la documentación.

5. Flujo de trabajo:

  • Analice la consulta del usuario para extraer temas clave, palabras clave y contexto.

  • Use la herramienta de índice para buscar en el índice de documentación y encontrar secciones relevantes.

  • Para cada documento o sección relevante identificado, use la herramienta de acceso a secciones para recuperar su contenido.

  • Combine el contenido recuperado, asegurándose de incluir todos los detalles necesarios y citando claramente.

Github:https://github.com/cyberagiinc/DevDocs

Sitio web oficial:https://www.cyberagi.ai/