Passar para o conteúdo principal

Sincronizar conteúdo do GitHub

Sincronize arquivos Markdown de um repositório GitHub para o Fin para que Fin e Copilot possam usá-los.

A sincronização de conteúdo do GitHub permite sincronizar arquivos Markdown (.md) de um repositório GitHub para o Fin, para que Fin e Copilot possam usá-los.


Começando

  1. Vá para Treinar > Conteúdo, clique em Ver tudo, depois escolha Do GitHub.

  2. Instale o app Fin GitHub sync para a conta GitHub que deseja conectar. Pode ser necessária aprovação do administrador da organização para instalar o app em uma conta organizacional.

  3. Escolha se o app pode acessar todos os repositórios ou apenas os selecionados.

  4. Quando a configuração do GitHub estiver concluída, a janela pop-up será fechada. Escolha o repositório e uma pasta, se necessário, de onde deseja sincronizar os arquivos Markdown.

  5. (Opcional) Escolha criar ou atualizar um arquivo CLAUDE.md com instruções para Claude Code sobre como criar e atualizar o conteúdo sincronizado e usar o esquema Frontmatter.

  6. Clique em Clonar e conectar.

Nota: Para dar acesso a um repositório diferente depois, clique em Gerenciar acesso ao repositório GitHub no GitHub. Isso abre a mesma janela pop-up, onde você pode adicionar repositórios à lista de permissões.


Permissões

O app Fin GitHub sync precisa destas permissões do GitHub:

  • Metadados (somente leitura): O escopo padrão que todo app GitHub possui.

  • Verificações (leitura e escrita): Executa as verificações do esquema Frontmatter descritas em verificações de PR abaixo.

  • Código (leitura e escrita): Cria ou atualiza o arquivo CLAUDE.md. Criar o arquivo é opcional, mas a permissão é necessária.

  • Pull requests (leitura e escrita): Cria o arquivo CLAUDE.md e recebe os webhooks que sincronizam as alterações para o Fin e executam as verificações de PR.

  • Workflows (leitura e escrita): Adiciona o workflow do GitHub Actions que permite que seu repositório aprove automaticamente e faça merge das pull requests de sugestão do Fin (configuração opcional de auto-merge).


Como a sincronização funciona

Quando você conecta seu repositório pela primeira vez, o Fin sincroniza todos os arquivos Markdown nele, ou na pasta que você escolheu. Depois disso, quando uma alteração nesses arquivos Markdown é mesclada, o Fin aplica as edições automaticamente.


(Opcional) Esquema Frontmatter

O Frontmatter não é obrigatório. Se seus arquivos Markdown ainda não o usam, você pode pular esta seção. O Frontmatter permite definir propriedades extras para como cada arquivo é sincronizado no Fin. Adicione-o no topo do seu arquivo Markdown, assim:

---
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…

Chaves e valores suportados:

  • title (qualquer texto): O título do artigo. Se estiver faltando, o Fin usa o primeiro H1 ou uma versão legível do nome do arquivo.

  • description (qualquer texto): Uma descrição curta mostrada abaixo do título do artigo.

  • published ou state (published, true, draft ou false): Se o artigo é sincronizado como publicado ou como rascunho. Publicado significa que o conteúdo está ativo e disponível para o Fin.

  • public_url (qualquer URL): A URL pública para onde os clientes são enviados quando o Fin cita este conteúdo. Sem ela, o Fin não cita uma fonte para o artigo.

  • service_agent ou service (enabled ou disabled): Se o Fin pode usar o artigo.

  • copilot (enabled ou disabled): Se o Copilot pode usar o artigo.

  • sales_agent ou sales (enabled ou disabled): Se o Sales Agent pode usar o artigo.

Todas as chaves e valores do Frontmatter são opcionais. Chaves não reconhecidas são ignoradas.


Verificações de PR

O Fin executa verificações leves nas pull requests que alteram seus arquivos Markdown sincronizados. Elas verificam se cada chave do Frontmatter é válida e suportada. Uma verificação falha aparece na seção de verificações da pull request, e você pode clicar nela para detalhes.

Nota: Essas verificações não bloqueiam o merge. Pull requests ainda podem ser mescladas se as verificações GitSync: Content Validation falharem. Para aplicá-las, veja o guia do GitHub sobre exigir verificações de status antes do merge.


Limitações conhecidas

  • Apenas arquivos Markdown (.md) são sincronizados. Arquivos .mdx ainda não são suportados.

  • Artigos sincronizados são desativados por padrão para Fin, Copilot e Sales Agent, para que você possa revisá-los antes de torná-los públicos.

  • Esta é uma sincronização unidirecional do GitHub para o Fin. Artigos sincronizados são somente leitura no Fin e devem ser editados no GitHub.

  • Artigos são atualmente criados apenas em inglês.

Respondeu à sua pergunta?