Base de code fr-CA tant que documents Shadow
Qu’est-ce que Code Base en tant que Shadow Docs
Lorsque vous synchronisez un dépôt GitHub avec un Space dans Archbee, vous avez la possibilité d’importer votre Code base dans ce Space en tant que Shadow Docs. Visitez documents Shadow 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 uniquement utilisé pour entraîner votre AI et permettre de répondre aux questions de vos utilisateurs concernant votre code.
Comment puis-je l’utiliser ?
Voici deux des cas d’usage les plus courants :
- Synchronisez la base de code de votre application dans un Space Archbee. Publiez un portail interne (protégé, non public) pour vos équipes techniques et non techniques. Ce portail, alimenté par notre AI, pourra maintenant répondre aux questions et même suggérer différentes améliorations, intégrations, optimisations, etc., basées sur votre base de code.
- Synchronisez la base de code de votre application dans un Space Archbee. Publiez un portail public pour vos utilisateurs. Ici, vos utilisateurs pourront obtenir des réponses directes sur la façon d’utiliser votre App, APIs, SDK, Libraries, etc.
Comment configurer
Vous devez d’abord 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 de la 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 inclure aussi les fichiers de documentation du dossier docs
root: docsVoici à quoi cela ressemblera après l’importation
Assurez-vous que votre Module complémentaire IA est activé dans les Organisation Settings
Sommaire
- Tous les fichiers de code synchronisés via Shadow Docs ne seront jamais rendus publics
- Le seul but est de fournir du contexte à notre AI pour qu’elle puisse répondre aux questions techniques et faire des suggestions techniques à vos utilisateurs internes ou publics