A sincronização de conteúdo do GitHub permite sincronizar seus arquivos Markdown (.md) do GitHub diretamente para Fin.
Primeiros passos
Para conectar seu repositório do GitHub, vá para Knowledge Hub > Ver tudo > From GitHub
Em seguida, você precisa instalar o aplicativo Fin GitHub sync para a conta que deseja conectar ao Fin.
Em seguida, escolha a conta na qual deseja instalar o aplicativo. Observe que pode ser necessária a aprovação do administrador da sua organização para instalar o aplicativo em uma conta da organização.
Depois de escolher uma conta, você pode optar por permitir o acesso a todos os repositórios ou apenas a um subconjunto específico.
Depois que a configuração for concluída no GitHub, a janela pop-up será fechada e você será solicitado a escolher o repositório e especificar uma pasta (se aplicável ao seu caso) da qual deseja sincronizar os arquivos Markdown.
(OPCIONAL) Você também pode optar por criar/atualizar o arquivo CLAUDE.md existente com instruções para Claude Code sobre como criar/atualizar o conteúdo sincronizado e usar o esquema Frontmatter.
Quando terminar, clique em "Clonar e conectar".
Observação: Se precisar permitir que um repositório diferente seja acessado do que você selecionou inicialmente, clique em "Manage GitHub repository access on GitHub", que abrirá a mesma janela pop-up que permitirá adicionar repositórios adicionais à lista de permitidos.
Permissões
O aplicativo Fin GitHub Sync requer as seguintes permissões do GitHub:
Permissão | Tipo | Por quê? |
Acesso a metadados | Somente leitura | Escopo do aplicativo que todos os aplicativos do GitHub têm por padrão |
Verificações | Leitura e gravação | Necessário para executar a verificação do esquema Frontmatter explicada aqui. |
Código | Leitura e gravação | Necessário para criar/atualizar o arquivo CLAUDE.md que fornece instruções ao Claude Code sobre como formatar os arquivos Markdown sincronizados para Fin. Este é um recurso opcional que você pode pular como parte da configuração, no entanto, essa permissão é necessária. |
Pull requests | Leitura e gravação | Necessário para criar um arquivo |
Workflows | Leitura e gravação | Necessário para adicionar o workflow do GitHub Actions que permite que seu repositório aprove e mescle automaticamente as Pull Requests de Sugestões do Fin (configuração opcional de auto-merge). |
Como a sincronização funciona
Quando você conecta inicialmente seu repositório, o Fin sincronizará todos os arquivos Markdown presentes.
Quando uma alteração for mesclada na pasta/repositório sincronizado que atualize os arquivos Markdown, aplicaremos essas edições automaticamente.
(OPCIONAL) Esquema Frontmatter
Observação: O esquema Frontmatter não é obrigatório. Se seus arquivos Markdown ainda não o utilizam, você pode pular esta seção.
Frontmatter permite especificar certas propriedades adicionais sobre como sincronizamos artigos para o Fin a partir dos seus arquivos Markdown.
Frontmatter é anexado ao topo do seu arquivo Markdown, similar a isto:
---
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…
Abaixo está uma lista das chaves e valores do Frontmatter atualmente suportados:
Chave | Valores permitidos | Descrição |
title | Qualquer texto | Especifique o título do seu artigo. Se não estiver presente, encontraremos o primeiro H1 ou humanizaremos o nome do arquivo markdown. |
description | Qualquer texto | Descrição curta que aparece abaixo do título de um artigo no Fin |
published / state |
| Especifique se o artigo será sincronizado como publicado ou rascunho |
public_url | Qualquer URL | Especifique uma URL pública para a qual você deseja direcionar os clientes quando o Fin citar este conteúdo como fonte. Se não for fornecida, o Fin não citará a fonte (o artigo será tratado como não listado) |
service_agent / service |
| Especifique se o artigo é acessível ao Fin AI Agent |
copilot |
| Especifique se o artigo é acessível ao Fin Copilot |
sales_agent / sales |
| Especifique se o artigo é acessível ao Fin Sales Agent |
Observação: Todas as chaves e valores do Frontmatter são opcionais. Chaves não reconhecidas são ignoradas.
Verificações de PR
Executamos um conjunto de verificações leves nos PRs que você abrir que tenham como alvo os arquivos markdown sincronizados.
As verificações executam no esquema Frontmatter para garantir que todas as chaves presentes sejam válidas e compatíveis.
Uma verificação falhada aparecerá na seção de verificações do pull request, semelhante ao exemplo abaixo.
Você também pode clicar na verificação para obter mais detalhes sobre as infrações detectadas.
Observação: Essas verificações não impedem a mesclagem. Os PRs ainda podem ser mesclados mesmo se as verificações GitSync: Content Validation falharem.
Você pode, no entanto, aplicar essas verificações conforme explicado na documentação do GitHub aqui.
Limitações conhecidas
Sincronize apenas arquivos Markdown (
.md). Arquivos.mdxnão são compatíveis no momento.Artigos sincronizados são desabilitados para AI Agent/Copilot/Sales Agent por padrão para permitir que você revise manualmente antes de torná-los públicos.
Esta é uma sincronização unidirecional apenas, do GitHub para o Fin. Os artigos atualmente devem ser editados no GitHub.
Os artigos são criados atualmente apenas em inglês.