Docusaurus

Sincronize seu site de documentação Docusaurus na base de conhecimento do AI SmartTalk. Sua IA aprenderá com cada página do seu sitemap—perfeito para bots de suporte que respondem a perguntas técnicas.

---

Visão Geral

A integração do Docusaurus permite que você:

• Importe todas as páginas do seu sitemap automaticamente
• Mantenha a documentação sincronizada quando você publicar atualizações
• Responda perguntas sobre sua documentação de forma conversacional
• Reduza a carga de suporte permitindo que a IA lide com perguntas comuns

Curiosidade: A própria documentação do AI SmartTalk usa Docusaurus, e esta integração alimenta nosso chatbot de suporte!

---

Pré-requisitos

Antes de começar, certifique-se de que você possui:

• Uma conta ativa no AI SmartTalk
• Um site Docusaurus com um sitemap.xml válido
• Seu site deve ser acessível publicamente (ou fornecer autenticação)

---

Configuração Passo a Passo

Passo 1: Localize Seu Sitemap

O Docusaurus gera automaticamente um sitemap. Encontre-o em:

https://your-docs-site.com/sitemap.xml

Verifique se ele carrega no seu navegador e contém suas páginas de documentação.

Passo 2: Adicione a Integração do Docusaurus

1. Faça login na sua conta do AI SmartTalk
2. Navegue até Configurações → Integrações
3. Encontre Docusaurus e clique em Conectar
4. Insira a URL do seu sitemap
5. Clique em Validar

Passo 3: Configure as Configurações de Importação

Após a validação, configure sua importação:

Configuração	Descrição
URL do Sitemap	URL completa para seu sitemap.xml
Padrões de inclusão	Sincronizar apenas páginas que correspondem a padrões (opcional)
Padrões de exclusão	Pular páginas ou seções específicas (opcional)

Passo 4: Inicie a Importação

1. Clique em Importar Páginas
2. O AI SmartTalk rastreia cada URL no seu sitemap
3. O conteúdo é extraído e adicionado à sua base de conhecimento
4. Aguarde a conclusão da importação (progresso mostrado)

Passo 5: Verifique a Importação

1. Vá para Conhecimento no AI SmartTalk
2. Suas páginas de documentação devem aparecer
3. Teste sua IA fazendo perguntas sobre sua documentação

---

O Que é Sincronizado

Conteúdo	Como É Processado
Título da página	Usado como identificador do documento
Conteúdo da página	Texto completo extraído do HTML
Cabeçalhos	Preservados para estrutura
Blocos de código	Incluídos como estão
Tabelas	Convertidas para formato legível
URLs	URL da página armazenada para referência

Extração de Conteúdo

O AI SmartTalk extrai a área principal de conteúdo e ignora:

• Menus de navegação
• Barras laterais
• Rodapés
• Scripts e estilos

---

Comportamento de Sincronização

Importação Manual

Clique em Importar nas configurações de integração para:

• Buscar o sitemap mais recente
• Adicionar novas páginas
• Atualizar páginas alteradas
• Remover páginas deletadas

Mantendo a Documentação Atualizada

Para uma documentação sempre atual:

1. Atualização manual: Clique em Importar após publicar atualizações
2. Sincronização programada: Use o SmartFlow para automatizar importações

Importação Programada do SmartFlow

Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
  - Sync Connector:
      Type: Docusaurus
      Sitemap: https://docs.example.com/sitemap.xml

---

Padrões de URL

Incluir Padrões

Sincronize apenas seções específicas:

Padrão	Efeito
/docs/api/*	Somente documentação da API
/docs/guides/*	Somente seção de guias
/blog/*	Somente postagens do blog

Excluir Padrões

Ignore certas páginas:

Padrão	Efeito
/docs/internal/*	Ignorar documentos internos
/changelog	Ignorar página de changelog
*/draft-*	Ignorar páginas de rascunho

---

Casos de Uso

Bot de Suporte Técnico

Sincronize sua documentação de produto:

• "Como faço para instalar o SDK?"
• "Quais são os limites de taxa da API?"
• "Mostre-me um exemplo de autenticação"

Documentação para Desenvolvedores

Sincronize referências e guias da API:

• "Quais parâmetros o endpoint /users aceita?"
• "Como faço para lidar com webhooks?"
• "Qual é a diferença entre a API v1 e v2?"

Base de Conhecimento Interna

Sincronize wikis e procedimentos da empresa:

• "Qual é o processo para solicitar PTO?"
• "Como configuro meu ambiente de desenvolvimento?"
• "Onde encontro as diretrizes da marca?"

---

Solução de Problemas

Problemas com Sitemap

Problema	Solução
"Sitemap inválido"	Verifique se a URL retorna XML válido
"Nenhuma página encontrada"	Verifique se o sitemap contém entradas <url>
"Acesso negado"	Certifique-se de que o sitemap é publicamente acessível

Problemas de Importação

Problema	Solução
Páginas ausentes	Verifique os padrões de inclusão/exclusão
Importação travada	Sites grandes levam tempo; aguarde ou importe em lotes
Conteúdo antigo	Reimporte para buscar as versões mais recentes

Qualidade do Conteúdo

Problema	Solução
Conteúdo errado extraído	Relate o problema—pode ser necessária extração personalizada
Blocos de código ausentes	Verifique se o código está nas tags padrão <pre><code>
Texto embaralhado	Verifique a codificação da página (UTF-8 recomendado)

---

Gerenciando a Integração

Ação	Como
Reimportar tudo	Clique em Importar nas configurações de integração
Alterar sitemap	Atualize a URL e reimporte
Remover conteúdo	Desconecte a integração ou exclua do Knowledge
Desconectar	Configurações → Integrações → Docusaurus → Desconectar

---

Melhores Práticas

1. Conteúdo de qualidade: Documentos bem escritos = melhores respostas de IA
2. Estrutura clara: Use cabeçalhos, listas e tabelas
3. Títulos descritivos: Títulos de página ajudam a IA a entender o contexto
4. Sincronizações regulares: Mantenha a IA atualizada com a documentação mais recente
5. Teste minuciosamente: Faça perguntas comuns para verificar a precisão da IA

---

Dicas de Configuração do Docusaurus

Otimize para Extração de IA

No seu docusaurus.config.js:

module.exports = {
  // Garantir que o sitemap seja gerado
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Use títulos de página descritivos
  title: 'Documentação do Seu Produto',
  
  // Incluir metadados
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentação para Seu Produto'
    }],
  },
};

Excluir Páginas do Sitemap

Para evitar que certas páginas sejam sincronizadas:

// No frontmatter da página
---
title: Página Interna
sitemap:
  exclude: true
---

---

Documentação Relacionada

• Visão Geral de Integrações
• Gerenciamento da Base de Conhecimento
• Integração de Feed RSS — Para conteúdo de blog/notícias
• Gatilhos Agendados do SmartFlow — Automatizar importações