Base de code en tant que documents fantômes
Qu’est-ce que Code Base as Shadow Docs
Lorsque vous synchronisez un dépôt GitHub à un Space dans Archbee, vous avez la possibilité d’importer votre base de code dans ce Space en tant que Shadow Docs. Visitez Documents de l’ombre pour en savoir plus.
Cela signifie que notre Système AI indexera tout le Code que vous avez configuré pour être synchronisé et entraînera l’Assistant Ask AI avec la base de code fournie.
Chaque document ajouté au dossier Shadow Docs ne sera pas visible sur votre portail publié, ni pour vos clients ni pour vos utilisateurs internes. Le code fourni via Shadow Docs sera seulement utilisé pour entraîner votre AI et être en mesure de répondre aux questions sur votre code pour vos utilisateurs.
Comment puis-je l’utiliser?
Voici deux des cas d’usage les plus courants :
- Synchronisez votre base de code d’application à un Space Archbee. Publiez un portail interne (protégé, non public) pour vos équipes techniques et non techniques. Ce portail, propulsé par notre AI, pourra désormais répondre à des questions et même suggérer comment effectuer différentes améliorations, intégrations, optimisations, etc., basées sur votre base de code.
- Synchronisez votre base de code d’application à un Space Archbee. Publiez un portail public pour vos utilisateurs. Ici, vos utilisateurs pourront obtenir des réponses directes sur la manière d’utiliser votre App, APIs, SDK, Libraries, etc.
Comment configurer
D’abord, vous devez configurer l’intégration GitHub comme expliqué ici.
Ensuite, vous devez configurer le dépôt
Dans le fichier archbee.yaml, vous devez configurer le paramètre shadowDocs avec le chemin vers votre base de code que vous souhaitez synchroniser avec Archbee.
# Ceci inclura tous les fichiers de code de votre dépôt
shadowDocs:
- "*"# Ceci inclura uniquement le fichier de code index.ts
shadowDocs:
- "init/index.ts"
# Pour également inclure les fichiers de documentation du dossier docs
root: docsVoici à quoi cela ressemblera après l’importation
Assurez-vous que votre Module d’IA est activé dans Organisation Settings
Résumé
- Tous les fichiers de code synchronisés via Shadow Docs ne seront rendus publics à aucun moment
- Le but entier est de fournir du contexte à notre AI afin qu’elle puisse répondre à des questions techniques et faire des suggestions techniques à vos utilisateurs internes ou publics