La synchronisation de contenu GitHub vous permet de synchroniser vos fichiers Markdown (.md) depuis GitHub directement dans Fin.
Prise en main
Pour connecter votre dépôt GitHub, rendez-vous sur Knowledge Hub > Voir tout > From 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 pouvez nécessiter l’approbation de l’administrateur de votre organisation pour installer l’application sur un compte organisationnel.
Une fois le compte choisi, vous pouvez autoriser l’accès à tous les dépôts ou uniquement à un sous-ensemble spécifique.
Une fois la configuration terminée sur GitHub, la fenêtre contextuelle se fermera et il vous sera demandé de choisir le dépôt et de spécifier un dossier (si applicable) à partir duquel vous souhaitez synchroniser les fichiers Markdown.
(OPTIONNEL) Vous pouvez également choisir de créer/mettre à jour le fichier CLAUDE.md avec des instructions pour Claude Code sur la manière de créer/mettre à jour le contenu synchronisé et d’utiliser le schéma Frontmatter.
Une fois terminé, cliquez sur « Clone and connect ».
Remarque : Si vous devez autoriser un dépôt différent de celui sélectionné initialement, cliquez sur “Manage GitHub repository access on GitHub” qui ouvrira la même fenêtre contextuelle vous permettant d’ajouter des dépôts supplémentaires à la liste d’autorisations.
Autorisations
L’application Fin GitHub Sync nécessite les autorisations GitHub suivantes :
Permission | Type | Pourquoi ? |
Accès aux métadonnées | Lecture seule | Périmètre d’application que toutes les apps GitHub ont par défaut |
Checks | Lecture & écriture | Nécessaire pour exécuter la vérification du schéma Frontmatter expliquée ici. |
Code | Lecture & écriture | Nécessaire pour créer/mettre à jour le fichier CLAUDE.md qui donne à Claude Code des instructions sur la façon de formater les fichiers Markdown synchronisés vers Fin. Il s’agit d’une fonctionnalité optionnelle que vous pouvez ignorer lors de la configuration, cependant, cette autorisation est requise. |
Pull requests | Lecture & écriture | Nécessaire pour créer un fichier |
Workflows | Lecture & écriture | Nécessaire pour ajouter le workflow GitHub Actions qui permet à votre dépôt d’approuver et de fusionner automatiquement les Pull Requests de Suggestions de Fin (configuration de fusion automatique optionnelle). |
Comment la synchronisation fonctionne
Lorsque vous connectez initialement votre dépôt, Fin synchronisera tous les fichiers Markdown présents.
Lorsqu’un changement est fusionné dans le dossier/dépôt synchronisé qui met à jour les fichiers Markdown, nous appliquerons ces modifications automatiquement.
(OPTIONNEL) Schéma Frontmatter
Remarque : 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 sur la façon dont nous synchronisons les articles dans Fin depuis 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…
Ci‑dessous figure 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. Si absent, nous trouverons le premier H1 ou nous 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é en tant que publié ou brouillon |
public_url | N’importe quelle URL | Spécifiez une URL publique vers laquelle vous souhaitez diriger les clients lorsque Fin cite ce contenu en tant que source. Si non fournie, Fin ne citera pas la source (l’article est traité comme non répertorié). |
service_agent / service |
| Spécifiez si l’article est accessible à l’agent IA de Fin |
copilot |
| Spécifiez si l’article est accessible à Fin Copilot |
sales_agent / sales |
| Spécifiez si l’article est accessible à Fin Sales Agent |
Remarque : Toutes les clés et valeurs Frontmatter sont optionnelles. Les clés non reconnues sont ignorées.
Vérifications des PR
Nous exécutons une série de vérifications légères sur les PR que vous ouvrez et qui ciblent les fichiers markdown synchronisés.
Les vérifications s’exécutent sur le schéma Frontmatter pour garantir 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.
Remarque : Ces vérifications ne bloquent pas. Les PR peuvent toujours être fusionnées même si les vérifications GitSync: Content Validation échouent.
Vous pouvez toutefois appliquer ces vérifications comme expliqué dans la documentation GitHub ici.
Limitations connues
Synchronise uniquement les fichiers Markdown (
.md). Les fichiers.mdxne sont pas pris en charge actuellement.Les articles sont synchronisés désactivés pour AI Agent/Copilot/Sales Agent par défaut afin de vous permettre de les examiner manuellement avant de les mettre en ligne.
Il s’agit d’une synchronisation unidirectionnelle uniquement, de GitHub vers Fin. Les articles doivent actuellement être modifiés sur GitHub.
Les articles sont actuellement créés uniquement en anglais.