Codebasis als Shadow-Dokumentation
Was ist eine Code Base als Shadow Docs
Wenn Sie ein GitHub-Repository mit einem Space in Archbee synchronisieren, haben Sie die Möglichkeit, Ihre Code Base als Shadow Docs in diesen Space zu importieren. Besuchen Sie Shadow-Dokumente , um mehr zu erfahren.
Das bedeutet, dass unser AI-System den gesamten Code indexieren wird, den Sie für die Synchronisierung konfiguriert haben, und den Ask AI-Assistent mit der bereitgestellten Code Base trainieren wird.
Jedes Dokument, das dem Shadow Docs-Ordner hinzugefügt wird, wird nicht sichtbar sein auf Ihrem veröffentlichten Portal sein, weder für Ihre Kunden noch für Ihre internen Benutzer. Der über Shadow Docs bereitgestellte Code dient lediglich dazu, Ihre AI zu trainieren und Fragen Ihrer Benutzer zu Ihrem Code beantworten zu können.
Wie kann ich es verwenden?
Hier sind 2 der häufigsten Anwendungsfälle:
- Synchronisieren Sie die Code Base Ihrer App mit einem Archbee Space. Veröffentlichen Sie ein internes (geschütztes, nicht öffentliches) Portal für Ihre technischen und nicht-technischen Teams. Dieses Portal, unterstützt von unserer AI, kann nun Fragen beantworten und sogar Vorschläge machen, wie verschiedene Verbesserungen, Integrationen, Optimierungen usw. basierend auf Ihrer Code Base durchgeführt werden können.
- Synchronisieren Sie die Code Base Ihrer App mit einem Archbee Space. Veröffentlichen Sie ein öffentliches Portal für Ihre Benutzer. Hier können Ihre Benutzer direkte Antworten dazu erhalten, wie Ihre App, APIs, SDK, Bibliotheken usw. verwendet werden.
Konfiguration
Zuerst müssen Sie die GitHub-Integration konfigurieren, wie hier erklärt.
Danach müssen Sie das Repository einrichten
In der Datei archbee.yaml müssen Sie den Parameter shadowDocs mit dem Pfad Ihrer Code Base konfigurieren, die Sie mit Archbee synchronisieren möchten.
# Dadurch werden alle Code-Dateien aus Ihrem Repository eingeschlossen
shadowDocs:
- "*"# Dadurch wird nur die Code-Datei index.ts eingeschlossen
shadowDocs:
- "init/index.ts"
# Um auch Dokumentationsdateien aus dem docs-Ordner einzuschließen
root: docsSo wird es nach dem Import aussehen
Stellen Sie sicher, dass Ihr KI-Add-on in den Organisationseinstellungen aktiviert ist
Zusammenfassung
- Alle Code-Dateien, die über Shadow Docs synchronisiert werden, werden zu keinem Zeitpunkt öffentlich gemacht
- Der gesamte Zweck besteht darin, unserer AI Kontext bereitzustellen, damit sie technische Fragen beantworten und technische Vorschläge für Ihre internen oder öffentlichen Benutzer machen kann