La synchronisation du contenu GitHub vous permet de synchroniser vos fichiers Markdown (.md) depuis GitHub directement dans Fin.
Commencer
Pour connecter votre dépôt GitHub, allez dans Knowledge Hub > Voir tout > Depuis GitHub
Ensuite, vous devez installer l'application Fin GitHub sync pour le compte que vous souhaitez connecter à Fin.
Puis, choisissez le compte pour lequel vous souhaitez installer l'application. Notez que vous pourriez avoir besoin de l'approbation de l'administrateur de votre organisation pour installer l'application sur un compte organisation.
Une fois que vous avez choisi un compte, vous pouvez choisir d'autoriser l'accès à tous les dépôts ou seulement à un sous-ensemble spécifique.
Une fois la configuration terminée sur GitHub, la fenêtre contextuelle se fermera et vous serez invité à choisir le dépôt et à spécifier un dossier (si cela s'applique dans votre cas) à partir duquel vous souhaitez synchroniser les fichiers Markdown.
(OPTIONNEL) Vous pouvez également choisir de créer/mette à jour un fichier CLAUDE.md existant avec des instructions pour Claude Code sur la façon de créer/mette à jour le contenu synchronisé et d'utiliser le schéma Frontmatter.
Une fois que vous avez terminé, cliquez sur « Cloner et connecter ».
Note : Si vous devez autoriser l'accès à un dépôt différent de celui sélectionné initialement, cliquez sur « Gérer l'accès au dépôt GitHub sur GitHub » qui ouvrira la même fenêtre contextuelle vous permettant d'ajouter des dépôts supplémentaires à la liste d'autorisation.
Autorisations
L'application Fin GitHub Sync nécessite les autorisations GitHub suivantes :
Autorisation | Type | Pourquoi ? |
Accès aux métadonnées | Lecture seule | Portée de l'application que toutes les applications GitHub ont par défaut |
Vérifications | Lecture et écriture | Nécessaire pour exécuter la vérification du schéma Frontmatter expliquée ici. |
Code | Lecture et écriture | Nécessaire pour créer/mette à jour le fichier CLAUDE.md qui donne à Claude Code des instructions sur la façon de formater les fichiers Markdown synchronisés vers Fin. C'est une fonctionnalité optionnelle que vous pouvez ignorer lors de la configuration, voir ci-dessus. Cependant, cette autorisation est requise. |
Pull requests | Lecture et écriture | Nécessaire pour créer un fichier |
Workflows | Lecture et écriture | Nécessaire pour ajouter le workflow GitHub Actions qui permet à votre dépôt d'approuver automatiquement et de fusionner les Pull Requests de Suggestions de Fin (configuration de fusion automatique optionnelle). |
Comment fonctionne la synchronisation
Lorsque vous connectez initialement votre dépôt, Fin synchronisera tous les fichiers Markdown présents.
Lorsqu'une modification est fusionnée dans le dossier/dépôt synchronisé qui met à jour les fichiers Markdown, nous appliquerons ces modifications automatiquement.
(OPTIONNEL) Schéma Frontmatter
Note : Le schéma Frontmatter n'est pas requis. Si vos fichiers Markdown ne l'utilisent pas déjà, vous pouvez ignorer cette section.
Frontmatter vous permet de spécifier certaines propriétés supplémentaires pour la façon dont nous synchronisons les articles dans Fin à partir de vos fichiers Markdown.
Le Frontmatter est ajouté en haut de votre fichier Markdown, similaire à ceci :
---
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…
Voici une liste des clés et valeurs Frontmatter actuellement prises en charge :
Clé | Valeurs autorisées | Description |
title | N'importe quel texte | Spécifiez le titre de votre article. S'il n'est pas présent, nous trouverons le premier H1 ou humaniserons le nom du fichier markdown. |
description | N'importe quel texte | Brève description qui apparaît sous le titre d'un article dans Fin |
published / state |
| Spécifiez si l'article est synchronisé comme publié ou brouillon. Publié signifie que le contenu est en ligne et disponible dans Fin — pas qu'il apparaît dans votre Help Center. |
public_url | N'importe quelle URL | Spécifiez une URL publique vers laquelle les clients sont dirigés lorsque Fin cite ce contenu comme source. Si elle n'est pas fournie, Fin ne citera pas de source pour cet article. Cela n'affecte pas l'apparition de l'article dans votre Help Center. Les articles synchronisés sont toujours non listés. |
service_agent / service |
| Spécifiez si l'article est accessible à Fin AI Agent |
copilot |
| Spécifiez si l'article est accessible à Fin Copilot |
sales_agent / sales |
| Spécifiez si l'article est accessible à Fin Sales Agent |
Note : Toutes les clés et valeurs Frontmatter sont optionnelles. Les clés non reconnues sont ignorées.
Vérifications PR
Nous exécutons une série de vérifications légères sur les PR que vous ouvrez ciblant les fichiers markdown synchronisés.
Les vérifications portent sur le schéma Frontmatter pour s'assurer que toutes les clés présentes sont valides et prises en charge.
Une vérification échouée s'affichera dans la section des vérifications de la pull request, comme ci-dessous.
Vous pouvez également cliquer sur la vérification pour obtenir plus de détails sur les infractions détectées.
Note : Ces vérifications ne bloquent pas. Les PR peuvent toujours être fusionnées même si les vérifications GitSync : Validation du contenu échouent.
Vous pouvez cependant appliquer ces vérifications comme expliqué dans la documentation GitHub ici.
Limitations connues
Les articles synchronisés sont non listés dans votre Help Center. Ils ne peuvent pas être ajoutés à un Help Center ou à une collection, donc les clients ne les trouveront pas en naviguant ou en recherchant dans votre Help Center. Fin AI Agent et Copilot peuvent toujours les utiliser une fois que vous activez la surface correspondante. Si vous avez besoin qu'un article apparaisse dans une collection Help Center, créez-le dans Intercom au lieu de le synchroniser depuis GitHub. Les articles synchronisés sont en lecture seule dans Intercom, et aucun paramètre ou champ frontmatter ne peut les rendre consultables ou recherchables dans un Help Center.
Synchronisez uniquement les fichiers Markdown (
.md). Les fichiers.mdxne sont actuellement pas pris en charge.Les articles synchronisés sont désactivés par défaut pour AI Agent/Copilot/Sales Agent afin de vous permettre de les examiner manuellement avant de les publier.
Il s'agit d'une synchronisation unidirectionnelle uniquement, de GitHub vers Fin. Les articles doivent actuellement être modifiés dans GitHub.
Les articles sont actuellement créés uniquement en anglais.