Base de código como documentos Sombra
Qué es Code Base como Shadow Docs
Cuando sincronizas un repositorio de GitHub a un Espacio en Archbee, tienes la posibilidad de importar tu base de código en ese Espacio como Shadow Docs. Visita Shadow docs para obtener más información.
Esto significa que nuestro Sistema de IA indexará todo el Código que configuraste para sincronizar y entrenará al Asistente Ask AI con la base de código proporcionada.
Cada documento añadido a la carpeta Shadow Docs no será visible en tu portal publicado, ni para tus clientes ni para tus usuarios internos. El código proporcionado mediante Shadow Docs solo estará ahí para entrenar tu IA y poder responder preguntas sobre tu código a tus usuarios.
¿Cómo puedo usarlo?
Aquí están 2 de los casos de uso más comunes:
- Sincroniza la base de código de tu aplicación con un Espacio de Archbee. Publica un portal interno (protegido, no público) para tus equipos técnicos y no técnicos. Este portal, impulsado por nuestra IA, ahora podrá responder preguntas e incluso sugerir cómo realizar diferentes mejoras, integraciones, optimizaciones, etc., basadas en tu base de código.
- Sincroniza la base de código de tu aplicación con un Espacio de Archbee. Publica un portal público para tus usuarios. Aquí tus usuarios podrán obtener respuestas directas sobre cómo usar tu aplicación, APIs, SDKs, bibliotecas, etc.
Cómo configurar
Primero necesitas configurar la integración de GitHub como se explica aquí.
Luego necesitas configurar el repositorio
En el archivo archbee.yaml necesitas configurar el parámetro shadowDocs con la ruta de tu base de código que deseas sincronizar con Archbee.
# Esto incluirá todos los archivos de código de tu repositorio
shadowDocs:
- "*"# Esto incluirá solo el archivo de código index.ts
shadowDocs:
- "init/index.ts"
# Para incluir también archivos de documentación de la carpeta docs
root: docsAsí se verá después de la importación
Asegúrate de tener tu Complemento de IA habilitado en la Configuración de la Organización
Resumen
- Todos los archivos de código sincronizados a través de Shadow Docs no se harán públicos en ningún momento
- El propósito completo es proporcionar contexto a nuestra IA para que pueda responder preguntas técnicas y hacer sugerencias técnicas a tus usuarios internos o públicos