A sincronização de conteúdo do GitHub permite que você sincronize seus arquivos Markdown (.md) do GitHub diretamente no Fin.
Começando
Para conectar seu repositório do GitHub, vá para Knowledge Hub > Ver tudo > Do GitHub
Em seguida, você precisa instalar o app Fin GitHub sync para a conta que deseja conectar ao Fin.
Então, escolha a conta para a qual deseja instalar o app. Observe que pode ser necessária a aprovação do administrador da sua organização para instalar o app em uma conta organizacional.
Depois de escolher uma conta, você pode optar por permitir o acesso a todos os repositórios ou apenas a um subconjunto específico.
Quando a configuração estiver 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 no 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".
Nota: Se precisar permitir o acesso a um repositório diferente do que você selecionou inicialmente, clique em "Gerenciar acesso ao repositório GitHub no GitHub", que abrirá a mesma janela pop-up que permitirá adicionar repositórios adicionais à lista de permissões.
Permissões
O app Fin GitHub Sync requer as seguintes permissões do GitHub:
Permissão | Tipo | Por quê? |
Acesso a metadados | Somente leitura | Escopo do app que todos os apps do GitHub têm por padrão |
Verificações | Leitura e escrita | Necessário para executar a verificação do esquema Frontmatter explicada aqui. |
Código | Leitura e escrita | Necessário para criar/atualizar o arquivo CLAUDE.md que fornece instruções para Claude Code sobre como formatar arquivos Markdown sincronizados no Fin. Este é um recurso opcional que você pode pular durante a configuração, mas esta permissão é necessária. |
Pull requests | Leitura e escrita | Necessário para criar um arquivo |
Workflows | Leitura e escrita | Necessário para adicionar o workflow do GitHub Actions que permite que seu repositório aprove automaticamente e mescle as Pull Requests de Sugestões do Fin (configuração opcional de mesclagem automática). |
Como a sincronização funciona
Quando você conecta seu repositório pela primeira vez, o Fin sincroniza todos os arquivos Markdown presentes.
Quando uma alteração é mesclada na pasta/repositório sincronizado que atualiza os arquivos Markdown, aplicaremos essas edições automaticamente.
(OPCIONAL) Esquema Frontmatter
Nota: O esquema Frontmatter não é obrigatório. Se seus arquivos Markdown ainda não o utilizam, você pode pular esta seção.
O Frontmatter permite especificar certas propriedades adicionais sobre como sincronizamos artigos no Fin a partir dos seus arquivos Markdown.
O Frontmatter é adicionado no topo do seu arquivo Markdown, semelhante 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 Frontmatter atualmente suportados:
Chave | Valores permitidos | Descrição |
título | 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. |
descrição | Qualquer texto | Descrição curta que aparece abaixo do título de um artigo no Fin |
publicado / estado |
| Especifique se o artigo será sincronizado como publicado ou rascunho. Publicado significa que o conteúdo está ativo e disponível no Fin — não que aparece no seu Help Center. |
public_url | Qualquer URL | Especifique uma URL pública para a qual os clientes são direcionados quando o Fin cita este conteúdo como fonte. Se não fornecida, o Fin não citará uma fonte para este artigo. Isso não afeta se o artigo aparece no seu Help Center. Artigos sincronizados são sempre não listados. |
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 |
Nota: Todas as chaves e valores do Frontmatter são opcionais. Chaves não reconhecidas são ignoradas.
Verificações de PR
Executamos uma série de verificações leves nos PRs que você abre que têm como alvo os arquivos markdown sincronizados.
As verificações são executadas no esquema Frontmatter para garantir que todas as chaves presentes sejam válidas e suportadas.
Uma verificação falha será exibida 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.
Nota: Essas verificações não bloqueiam. 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
Artigos sincronizados são não listados no seu Help Center. Eles não podem ser adicionados a um Help Center ou a uma coleção, então os clientes não os encontrarão navegando ou pesquisando no seu Help Center. Fin AI Agent e Copilot ainda podem usá-los uma vez que você habilite a superfície relevante. Se precisar que um artigo apareça em uma coleção do Help Center, crie-o no Intercom em vez de sincronizá-lo do GitHub. Artigos sincronizados são somente leitura no Intercom, e nenhuma configuração ou campo frontmatter pode torná-los navegáveis ou pesquisáveis em um Help Center.
Sincronize apenas arquivos Markdown (
.md). Arquivos.mdxatualmente não são suportados.Artigos sincronizados são desativados para AI Agent/Copilot/Sales Agent por padrão para permitir que você revise manualmente antes de publicá-los.
Esta é uma sincronização unidirecional, do GitHub para o Fin. Os artigos devem ser editados no GitHub atualmente.
Os artigos são criados atualmente apenas em inglês.