GitHub Integration

Die GitHub Integration ermöglicht es Ihren KI-Assistenten, automatisch Wissensdatenbank-Inhalte aus GitHub-Repositories zu synchronisieren. Dies hält Ihre Assistenten mit Dokumentation, FAQs und anderem in Ihren GitHub-Repositories gespeicherten Wissen auf dem neuesten Stand.

Was ist die GitHub Integration?

GitHub ist die weltweit größte Plattform für Softwareentwicklung und Zusammenarbeit. Durch die Integration von GitHub mit Ihrem KI-Assistenten können Sie automatisch Dokumentation, Markdown-Dateien und andere Wissensinhalte aus Ihren Repositories direkt in die Wissensdatenbank Ihres Assistenten synchronisieren.

Hauptfunktionen

Wissensdatenbank-Synchronisation: Automatische Synchronisation von Dokumentation und Inhalten aus GitHub-Repositories
Datei-Filterung: Konfigurieren Sie, welche Dateien und Ordner in die Synchronisation einbezogen werden
Echtzeit-Updates: Halten Sie das Wissen Ihres Assistenten mit Repository-Änderungen aktuell
OAuth-Authentifizierung: Sichere Verbindung über GitHub OAuth
Repository-Zugriff: Verbindung zu öffentlichen und privaten Repositories, auf die Sie Zugriff haben
Flexible Konfiguration: Passen Sie Sync-Einstellungen für verschiedene Repositories an

Wie es funktioniert

Mit GitHub verbinden: Authentifizierung über Ihr GitHub-Konto via OAuth
Repository auswählen: Wählen Sie das GitHub-Repository mit Ihren Wissensinhalten
Datei-Filter konfigurieren: Spezifizieren Sie, welche Dateien oder Ordner synchronisiert werden sollen
Automatische Synchronisation: Das System synchronisiert regelmäßig Inhalte aus Ihrem Repository
Wissensdatenbank-Update: Neue und aktualisierte Inhalte werden für Ihren Assistenten verfügbar

GitHub Integration einrichten

Voraussetzungen

GitHub-Konto mit Zugriff auf das Repository, das Sie synchronisieren möchten
Repository mit Dokumentation oder Wissensinhalten
KI-Assistent in Ihrer KI Agency Plattform konfiguriert

Schritt-für-Schritt Einrichtung

Zu Integrationen navigieren
- Gehen Sie zum Hauptmenü und wählen Sie "Integrationen"
- Finden Sie die GitHub Integration in der Liste verfügbarer Integrationen
Mit GitHub verbinden
- Klicken Sie auf "Verbinden" bei der GitHub Integration
- Sie werden zu GitHub für OAuth-Authentifizierung weitergeleitet
- Autorisieren Sie die KI Agency Anwendung für den Zugriff auf Ihre Repositories
Wissensdatenbank-Bereich aufrufen
- Navigieren Sie vom Hauptmenü zur "Wissensdatenbank"
- Suchen Sie nach dem "+" Button, um neue Inhalte hinzuzufügen
- Finden Sie die GitHub Integration Option im Dropdown-Menü
Repository-Einstellungen konfigurieren
- Klicken Sie auf die GitHub Integration Option
- Sie sehen einen Konfigurationsdialog für GitHub-Eigenschaften
Repository-Details festlegen
- GitHub repo: Geben Sie den Repository-Namen ein (z.B. benutzername/repository-name)
- Repo files search: Spezifizieren Sie Dateimuster zum Einschließen (z.B. docs/**/*.md für alle Markdown-Dateien im docs-Ordner)
Konfiguration speichern
- Klicken Sie auf "Verbinden", um Ihre Repository-Einstellungen zu speichern
- Das System beginnt mit der Synchronisation von Inhalten aus Ihrem spezifizierten Repository

Konfigurationsoptionen

Repository-Auswahl

Spezifizieren Sie das GitHub-Repository, das Sie synchronisieren möchten, mit nur dem Repository-Namen. Das System sucht automatisch in allen Organisationen und Repositories, auf die Sie Zugriff haben:

dokumentation - Dokumentations-Repository
projekt-docs - Projekt-Dokumentation
wissensdatenbank - Wissens-Repository

Datei-Filterung

Verwenden Sie Dateimuster, um zu kontrollieren, welche Inhalte synchronisiert werden:

Beispiele:

**/*.md - Alle Markdown-Dateien im gesamten Repository
docs/**/*.md - Nur Markdown-Dateien im docs-Ordner
**/*.{md,txt} - Alle Markdown- und Textdateien
wiki/**/* - Alle Dateien im wiki-Ordner
README.md - Nur die Haupt-README-Datei

Muster-Tipps:

** entspricht einer beliebigen Anzahl von Verzeichnissen
* entspricht beliebigen Zeichen innerhalb einer einzelnen Verzeichnisebene
Verwenden Sie Dateierweiterungen, um auf bestimmte Dateitypen zu beschränken
Kombinieren Sie Muster mit Kommas: {md,txt,rst}

Best Practices

Repository-Organisation

Halten Sie Dokumentation in klar organisierten Ordnern
Verwenden Sie konsistente Namenskonventionen für Dateien
Schließen Sie eine Haupt-README-Datei für Übersichtsinformationen ein
Strukturieren Sie Inhalte logisch für einfache Navigation

Datei-Filterung

Seien Sie spezifisch mit Dateimustern, um unnötige Dateien zu vermeiden
Konzentrieren Sie sich auf Dokumentation und Wissensinhalte (Markdown, Textdateien)
Schließen Sie Code-Dateien, Bilder und Binärdateien aus, es sei denn, sie werden benötigt
Testen Sie Muster zuerst mit einer kleinen Teilmenge

Inhalts-Verwaltung

Schreiben Sie klare, benutzerfreundliche Dokumentation
Halten Sie Inhalte in Ihrem Repository aktuell
Verwenden Sie Markdown-Formatierung für bessere Lesbarkeit
Schließen Sie Beispiele und Schritt-für-Schritt Anleitungen ein

Sicherheit

Synchronisieren Sie nur öffentliche Informationen oder angemessen verwaltete private Inhalte
Vermeiden Sie die Einbeziehung sensibler Informationen wie API-Schlüssel oder Passwörter
Überprüfen Sie Repository-Berechtigungen regelmäßig
Verwenden Sie private Repositories für vertrauliche Dokumentation

Inhalts-Synchronisation

Synchronisations-Häufigkeit

Das System prüft automatisch periodisch auf Updates
Neue Commits in Ihrem Repository lösen Inhalts-Updates aus
Manuelle Sync-Optionen können über die Benutzeroberfläche verfügbar sein

Inhalts-Verarbeitung

Markdown-Formatierung wird beibehalten und angemessen gerendert
Dateihierarchie wird in der Wissensdatenbank beibehalten
Große Dateien können in Blöcken verarbeitet werden
Binärdateien und Bilder werden typischerweise ausgeschlossen

Fehlerbehebung

Häufige Probleme

Authentifizierungsprobleme

Überprüfen Sie, dass Ihr GitHub-Konto Zugriff auf das spezifizierte Repository hat
Authentifizieren Sie sich erneut, wenn die OAuth-Verbindung abläuft
Prüfen Sie, dass Repository-Berechtigungen Lesezugriff erlauben

Keine Inhalts-Synchronisation

Überprüfen Sie, dass der Repository-Name korrekt ist
Prüfen Sie, dass Ihre Dateifiltermuster mit vorhandenen Dateien übereinstimmen
Stellen Sie sicher, dass das Repository Dateien enthält, die Ihren Kriterien entsprechen

Sync-Fehler

Überprüfen Sie Dateifiltermuster auf Syntaxfehler
Prüfen Sie Repository-Zugänglichkeit und Berechtigungen
Verifizieren Sie Netzwerkverbindung zu GitHub

Hilfe erhalten

Wenn Sie Probleme mit der GitHub Integration haben:

Überprüfen Sie Ihre Repository-Einstellungen und Dateimuster
Prüfen Sie den Integrationsstatus im Wissensdatenbank-Bereich
Testen Sie zuerst mit einem einfachen Dateimuster wie *.md
Kontaktieren Sie Ihren Systemadministrator, falls Probleme bestehen bleiben

Beispiel-Konfigurationen

Dokumentations-Repository

Repository: docs
Datei-Filter: docs/**/*.md
Beschreibung: Synchronisiert alle Markdown-Dateien aus dem docs-Ordner

FAQ-Repository

Repository: faq-inhalte
Datei-Filter: **/*.{md,txt}
Beschreibung: Synchronisiert alle Dokumentations- und Textdateien für FAQ-Inhalte

Projekt-Wiki

Repository: projekt-wiki
Datei-Filter: wiki/**/*
Beschreibung: Synchronisiert komplette wiki-Ordner-Inhalte

Verwandte Dokumentation

Wissensdatenbank-Verwaltung - Erfahren Sie mehr über die Verwaltung des Wissens Ihres Assistenten
Integrationen Übersicht - Entdecken Sie andere verfügbare Integrationen
Assistenten-Konfiguration - Konfigurieren Sie Ihre KI-Assistenten-Einstellungen

Die GitHub Integration bietet eine mächtige Möglichkeit, das Wissen Ihres KI-Assistenten aktuell zu halten, indem automatisch Inhalte aus Ihren Repositories synchronisiert werden. So hat Ihr Assistent immer Zugriff auf die neueste Dokumentation und Informationen.