GitHub-Content-Sync ermöglicht es Ihnen, Ihre Markdown (.md)-Dateien direkt von GitHub in Fin zu synchronisieren.
Erste Schritte
Um Ihr GitHub-Repository zu verbinden, gehen Sie zu Knowledge Hub > Alle anzeigen > From GitHub
Als Nächstes müssen Sie die Fin GitHub Sync App für das Konto installieren, das Sie mit Fin verbinden möchten.
Wählen Sie dann das Konto aus, für das Sie die App installieren möchten. Hinweis: Möglicherweise benötigt die Installation für ein Organisationskonto die Genehmigung Ihres Organisationsadministrators.
Sobald Sie ein Konto ausgewählt haben, können Sie entweder den Zugriff auf alle Repositories oder nur auf eine bestimmte Auswahl erlauben.
Sobald die Einrichtung auf GitHub abgeschlossen ist, schließt sich das Pop-up-Fenster und Sie werden aufgefordert, das Repository auszuwählen und einen Ordner anzugeben (falls zutreffend), aus dem Sie Markdown-Dateien synchronisieren möchten.
(OPTIONAL) Sie können außerdem wählen, eine vorhandene CLAUDE.md-Datei zu erstellen/aktualisieren mit Anweisungen für Claude Code, wie synchronisierte Inhalte erstellt/aktualisiert und das Frontmatter-Schema verwendet werden soll.
Wenn Sie fertig sind, klicken Sie auf „Klonen und verbinden“.
Hinweis: Wenn Sie einem anderen Repository als dem ursprünglich ausgewählten Zugriff erlauben müssen, klicken Sie auf „Manage GitHub repository access on GitHub“, wodurch dasselbe Popup-Fenster geöffnet wird, mit dem Sie zusätzliche Repositories zur Allow-List hinzufügen können.
Berechtigungen
Die Fin GitHub Sync App benötigt die folgenden GitHub-Berechtigungen:
Permission | Type | Why? |
Metadaten-Zugriff | Nur Lesen | App-Bereich, den alle GitHub-Apps standardmäßig haben |
Checks | Lesen & Schreiben | Erforderlich, um die unter hier erklärte Frontmatter-Schema-Prüfung auszuführen. |
Code | Lesen & Schreiben | Erforderlich, um die CLAUDE.md-Datei zu erstellen/aktualisieren, die Claude Code Anweisungen zur Formatierung der in Fin synchronisierten Markdown-Dateien gibt. Dies ist eine optionale Funktion, die Sie während der Einrichtung überspringen können, aber diese Berechtigung ist erforderlich. |
Pull Requests | Lesen & Schreiben | Erforderlich, um eine |
Workflows | Lesen & Schreiben | Erforderlich, um den GitHub Actions-Workflow hinzuzufügen, der es Ihrem Repository ermöglicht, Fin's Suggestions Pull Requests automatisch zu genehmigen und zu mergen (optionale Auto-Merge-Einrichtung). |
Wie die Synchronisierung funktioniert
Wenn Sie Ihr Repository zunächst verbinden, synchronisiert Fin alle vorhandenen Markdown-Dateien.
Wenn eine Änderung in dem synchronisierten Ordner/Repository zusammengeführt wird, die die Markdown-Dateien aktualisiert, werden diese Änderungen automatisch übernommen.
(OPTIONAL) Frontmatter-Schema
Hinweis: Das Frontmatter-Schema ist nicht erforderlich. Wenn Ihre Markdown-Dateien es nicht verwenden, können Sie diesen Abschnitt überspringen.
Frontmatter ermöglicht es Ihnen, bestimmte zusätzliche Eigenschaften anzugeben, wie wir Artikel beim Import aus Ihren Markdown-Dateien in Fin synchronisieren.
Frontmatter wird oben in Ihrer Markdown-Datei angehängt, ähnlich wie hier:
---
title: How to request a refund
description: Steps to get a refund on your order
audience: everyone
published: true
fin: enabled
copilot: enabled
sales_agent: disabled
---
Article body goes here…
Nachfolgend finden Sie eine Liste der derzeit unterstützten Frontmatter-Schlüssel und -Werte:
Key | Allowed values | Description |
title | Beliebiger Text | Geben Sie den Titel Ihres Artikels an. Falls nicht vorhanden, finden wir die erste H1 oder wir humanisieren den Markdown-Dateinamen. |
description | Beliebiger Text | Kurze Beschreibung, die unter dem Titel eines Artikels in Fin angezeigt wird |
published / state |
| Geben Sie an, ob der Artikel als veröffentlicht oder als Entwurf synchronisiert werden soll |
public_url | Beliebige URL | Geben Sie eine öffentliche URL an, auf die Kunden verwiesen werden sollen, wenn Fin diesen Inhalt als Quelle zitiert. Wenn keine angegeben ist, wird Fin die Quelle nicht zitieren (Artikel wird als nicht gelistet behandelt). |
service_agent / service |
| Geben Sie an, ob der Artikel für den Fin AI Agent zugänglich ist |
copilot |
| Geben Sie an, ob der Artikel für Fin Copilot zugänglich ist |
sales_agent / sales |
| Geben Sie an, ob der Artikel für den Fin Sales Agent zugänglich ist |
Hinweis: Alle Frontmatter-Schlüssel und -Werte sind optional. Nicht erkannte Schlüssel werden übersprungen.
PR-Prüfungen
Wir führen eine Reihe leichter Prüfungen für die PRs durch, die Sie öffnen und die auf die synchronisierten Markdown-Dateien abzielen.
Prüfungen werden am Frontmatter-Schema durchgeführt, um sicherzustellen, dass alle vorhandenen Schlüssel gültig und unterstützt sind.
Eine fehlgeschlagene Prüfung wird im Prüfungsabschnitt des Pull Requests angezeigt, ähnlich wie unten.
Sie können auch auf die Prüfung klicken, um weitere Details zu den festgestellten Verstößen zu erhalten.
Hinweis: Diese Prüfungen sind nicht blockierend. PRs können weiterhin zusammengeführt werden, auch wenn die GitSync: Content Validation-Prüfungen fehlschlagen.
Sie können diese Prüfungen jedoch wie in den GitHub-Dokumenten hier beschrieben durchsetzen.
Bekannte Einschränkungen
Nur Markdown (
.md)-Dateien synchronisieren..mdx-Dateien werden derzeit nicht unterstützt.Synchronisierte Artikel sind standardmäßig für AI Agent/Copilot/Sales Agent deaktiviert, damit Sie diese vor dem Live-Schalten manuell überprüfen können.
Dies ist eine Einbahn-Synchronisation, nur von GitHub zu Fin. Artikel müssen derzeit in GitHub bearbeitet werden.
Artikel werden derzeit nur auf Englisch erstellt.