Code base as Shadow docs
Qué es Code Base como Shadow Docs
Cuando sincroniza un repositorio de GitHub con un Space en Archbee, tiene la posibilidad de importar su Code base en ese Space como Shadow Docs. Visite Documentos sombra para obtener más información.
Esto significa que nuestro sistema de IA indexará todo el Code que configuró para sincronizarse y entrenará al Asistente Ask AI con la base de código proporcionada.
Cada documento agregado a la carpeta Shadow Docs no será visible en su portal publicado, ni para sus clientes ni para sus usuarios internos. El código proporcionado a través de Shadow Docs solo estará allí para entrenar su IA y permitirle responder preguntas sobre su código a sus usuarios.
¿Cómo puedo usarlo?
Aquí tiene 2 de los casos de uso más comunes:
- Sincronice su app code base con un Space de Archbee. Publique un portal interno (protegido, no público) para sus 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., basándose en su code-base.
- Sincronice su app code base con un Space de Archbee. Publique un portal público para sus usuarios. Allí sus usuarios podrán obtener respuestas directas sobre cómo usar su App, APIs, SDK, Libraries, etc.
Cómo configurar
Primero necesita configurar la integración de GitHub como se explica aquí.
Luego necesita configurar el repositorio
En el archivo archbee.yaml necesita configurar el parámetro shadowDocs con la ruta de su code base que desea sincronizar con Archbee.
# This will include all code files from your repo
shadowDocs:
- "*"# This will include only the index.ts code file
shadowDocs:
- "init/index.ts"
# To also include documentation files from docs folder
root: docsAsí es como se verá después de la importación
Asegúrese de tener su Complemento de IA habilitado en Configuraciones de Organización
Resumen
- Todos los archivos de código sincronizados mediante 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 sus usuarios internos o públicos