Die GitHub-Inhaltssynchronisierung 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 > Von 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. Beachten Sie, dass Sie möglicherweise die Genehmigung Ihres Organisationsadministrators benötigen, um die App für ein Organisationskonto zu installieren.
Sobald Sie ein Konto ausgewählt haben, können Sie entweder den Zugriff auf alle Repositories oder nur auf eine bestimmte Auswahl erlauben.
Nachdem die Einrichtung auf GitHub abgeschlossen ist, wird das Pop-up-Fenster geschlossen und Sie werden aufgefordert, das Repository auszuwählen und einen Ordner anzugeben (falls dies in Ihrem Fall zutrifft), aus dem Sie Markdown-Dateien synchronisieren möchten.
(OPTIONAL) Sie können auch wählen, eine vorhandene CLAUDE.md-Datei mit Anweisungen für Claude Code zu erstellen/aktualisieren, wie synchronisierte Inhalte erstellt/aktualisiert und das Frontmatter-Schema verwendet wird.
Wenn Sie fertig sind, klicken Sie auf „Klonen und verbinden“.
Hinweis: Wenn Sie einem anderen Repository Zugriff gewähren müssen als dem, das Sie ursprünglich ausgewählt haben, klicken Sie auf „GitHub-Repository-Zugriff auf GitHub verwalten“, wodurch dasselbe Pop-up-Fenster geöffnet wird, das Ihnen erlaubt, weitere Repositories zur Zulassungsliste hinzuzufügen.
Berechtigungen
Die Fin GitHub Sync App benötigt folgende GitHub-Berechtigungen:
Berechtigung | Typ | Warum? |
Metadatenzugriff | Nur Lesen | App-Bereich, den alle GitHub-Apps standardmäßig haben |
Checks | Lesen & Schreiben | Erforderlich, um den Frontmatter-Schema-Check auszuführen, der hier erklärt wird. |
Code | Lesen & Schreiben | Erforderlich, um die CLAUDE.md-Datei zu erstellen/aktualisieren, die Claude Code Anweisungen gibt, wie synchronisierte Markdown-Dateien für Fin formatiert werden. Dies ist eine optionale Funktion, die Sie beim Setup ü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 zusammenzuführen (optionale Auto-Merge-Einrichtung). |
Wie die Synchronisierung funktioniert
Wenn Sie Ihr Repository zum ersten Mal verbinden, synchronisiert Fin alle vorhandenen Markdown-Dateien.
Wenn eine Änderung in dem synchronisierten Ordner/Repository zusammengeführt wird, die die Markdown-Dateien aktualisiert, wenden wir diese Änderungen automatisch an.
(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 aus Ihren Markdown-Dateien in Fin synchronisieren.
Frontmatter wird oben in Ihre 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…
Unten finden Sie eine Liste der derzeit unterstützten Frontmatter-Schlüssel und -Werte:
Schlüssel | Zulässige Werte | Beschreibung |
title | Beliebiger Text | Geben Sie den Titel Ihres Artikels an. Wenn nicht vorhanden, suchen wir die erste H1-Überschrift oder machen den Dateinamen lesbar. |
description | Beliebiger Text | Kurze Beschreibung, die unter dem Titel eines Artikels in Fin erscheint |
published / state |
| Geben Sie an, ob der Artikel als veröffentlicht oder Entwurf synchronisiert wird. Veröffentlicht bedeutet, dass der Inhalt live und in Fin verfügbar ist – nicht, dass er in Ihrem Help Center erscheint. |
public_url | Beliebige URL | Geben Sie eine öffentliche URL an, auf die Kunden weitergeleitet werden, wenn Fin diesen Inhalt als Quelle zitiert. Wenn keine URL angegeben ist, zitiert Fin keine Quelle für diesen Artikel. Dies beeinflusst nicht, ob der Artikel in Ihrem Help Center erscheint. Synchronisierte Artikel sind immer nicht gelistet. |
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-Checks
Wir führen eine Reihe von leichten Prüfungen an den PRs durch, die Sie öffnen und die auf die synchronisierten Markdown-Dateien abzielen.
Es werden Prüfungen 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üfungsbereich des Pull Requests angezeigt, ähnlich wie unten.
Sie können auch auf die Prüfung klicken, um weitere Details zu den erkannten 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 durchsetzen, wie in den GitHub-Dokumenten hier erklärt.
Bekannte Einschränkungen
Synchronisierte Artikel sind in Ihrem Help Center nicht gelistet. Sie können nicht zu einem Help Center oder einer Sammlung hinzugefügt werden, sodass Kunden sie nicht durch Durchsuchen oder Suchen im Help Center finden. Fin AI Agent und Copilot können sie weiterhin verwenden, sobald Sie die entsprechende Oberfläche aktivieren. Wenn ein Artikel in einer Help Center-Sammlung erscheinen soll, erstellen Sie ihn in Intercom, anstatt ihn von GitHub zu synchronisieren. Synchronisierte Artikel sind in Intercom schreibgeschützt, und keine Einstellung oder Frontmatter-Feld kann sie durchsuchbar oder auffindbar im Help Center machen.
Synchronisieren Sie nur Markdown (
.md) Dateien..mdx-Dateien werden derzeit nicht unterstützt.Synchronisierte Artikel sind standardmäßig für AI Agent/Copilot/Sales Agent deaktiviert, damit Sie diese vor der Veröffentlichung manuell überprüfen können.
Dies ist eine Einweg-Synchronisierung von GitHub zu Fin. Artikel müssen derzeit in GitHub bearbeitet werden.
Artikel werden derzeit nur in Englisch erstellt.