Pular para o conteúdo principal
Docusaurus Suporte para documentos

Adicione um chatbot de IA com citações de fontes à sua documentação Docusaurus

Um chatbot de IA para Docusaurus para redatores técnicos, DevRel e equipes de suporte. O ChattyBox rastreia sua documentação Docusaurus, responde a perguntas como "Como faço para configurar versionamento?" a partir dessas páginas e cita a fonte usada. Sem RAG personalizado e sem migração.

Rastreia páginas de documentos publicadosRespostas citadas pela fonteIncorpora com um scriptNão é necessária migração de documentosNão é necessário cartão de créditoO seu conteúdo continua a ser seu
Cadastre-se para testar nosso plano Free

Está avaliando o ChattyBox para uma organização? Entre em contato com o suporte para conversar sobre um período de teste de um plano mais completo.

Pergunte ao ChattyBox
x
Por onde devo começar se preciso de uma resposta confiável deste site?
Comece adicionando o URL do seu site ao ChattyBox. Ele rastreia seu conteúdo, responde a partir das páginas que encontra e mostra aos visitantes as fontes por trás de cada resposta.
iFontes3^
Docusaurus guia
chattybox.ai
Análises
chattybox.ai
Início
chattybox.ai
Faça uma pergunta...
Distribuído por ChattyBox
Configuração de autoatendimento

Nenhuma chamada de vendas necessária

Algumas ferramentas de suporte de IA fazem com que você reserve uma demonstração antes mesmo de testar o produto. ChattyBox é de autoatendimento: adicione seu site, rastreie seus documentos, teste o chatbot e incorpore-o quando estiver pronto.

Ferramentas tradicionais de suporte de IA

  • Agende uma demonstração
  • Preços ocultos ou baseados em vendas
  • Focado na empresa
  • Conversa de vendas primeiro

Configuração de autoatendimento

ChattyBox

  • Comece imediatamente
  • Preços públicos
  • Criado para sites de documentos, pequenas equipes, OSS e SaaS
  • Teste você mesmo primeiro
Construído para Equipes Docusaurus

Lance um chatbot com citações de fontes sem reconstruir sua stack do site

O ChattyBox rastreia seu site, documentação, central de ajuda, CMS ou base de conhecimento existentes e, em seguida, incorpora um chatbot que responde com base no seu próprio conteúdo publicado, em vez da memória genérica do modelo.

Um wrapper Root do Docusaurus 3 carrega o widget uma única vez durante todo o ciclo de vida da aplicação cliente.
O escopo do rastreamento pode seguir rotas de documentação atuais, versionadas, localizadas ou filtradas intencionalmente.
As citações levam os leitores de volta à página de apoio do Docusaurus e preservam o caminho da versão e da localidade.
O exemplo reproduzível abrange prevenção de duplicatas, navegação no cliente, CSP e verificação por rota.
1Etapa do fluxo de trabalho

Escolha o sitemap de produção do Docusaurus ou um conjunto intencional de rotas atuais, versionadas e localizadas da documentação.

2Etapa do fluxo de trabalho

Rastreie as rotas selecionadas e depois teste as perguntas na versão e na localidade exatas usadas pelos visitantes.

3Etapa do fluxo de trabalho

Instale um único carregador persistente em src/theme/Root.tsx e permita as origens do script e da API na sua Content Security Policy.

4Etapa do fluxo de trabalho

Navegue entre as páginas da documentação sem recarregar e verifique se há uma única instância do widget, citações funcionais e nenhum erro no console ou de CSP.

Lançamento em três etapas

Cole seu URL Docusaurus, teste as respostas citadas e instale o widget.

Evidências editoriais testadas

Uma integração testada com o Docusaurus 3, não um script por rota

O Docusaurus renderiza uma aplicação React persistente durante as mudanças de rota no cliente. Por isso, o wrapper Root testado cria um único carregador, reconhece montagens posteriores pelo ID e mantém o carregador no lugar, em vez de remover um widget ainda ativo durante remontagens no desenvolvimento.

Autor técnico
Equipe de documentação da ChattyBox
Revisor técnico
Engenharia da ChattyBox
Última atualização
Informações verificadas
Docusaurus 3.10 e widget atual da ChattyBox

Verifique novamente o ciclo de vida do Root, a saída do sitemap e as origens de CSP após uma atualização principal do Docusaurus ou uma mudança no endpoint do widget.

Componente Root do Docusaurus impedindo a duplicação do script da ChattyBox após a navegação no cliente
Referência original de instalação: o carregador tem um ID estável, carrega de forma assíncrona e permanece presente enquanto o Docusaurus muda de rota.
Decisões de instalação do Docusaurus 3 e suas verificações de ponta a ponta.
Questão do DocusaurusDecisão de implementaçãoVerificação
Questão do Docusaurus
Root e navegação no cliente
Decisão de implementação
Crie o script assíncrono uma única vez com um ID estável. Não retorne uma limpeza do efeito, pois o Root e o widget devem persistir entre as rotas.
Verificação
Abra dois links internos da documentação e confirme que document.querySelectorAll("#chattybox-widget").length é 1.
Questão do Docusaurus
Política de Segurança de Conteúdo
Decisão de implementação
Permita chattybox.ai em script-src, a origem configurada da API em connect-src, fonts.googleapis.com em style-src e fonts.gstatic.com em font-src. O widget atual injeta o CSS de seu componente, então um style-src estrito também precisa de 'unsafe-inline' até que haja um build com nonce ou stylesheet externo.
Verificação
Recarregue com o DevTools aberto e confirme que não há solicitações de script, style, font, fetch ou WebSocket bloqueadas.
Questão do Docusaurus
Versões, localidades e escopo do sitemap
Decisão de implementação
Inspecione o sitemap implantado antes do rastreamento. Inclua somente caminhos de versões e localidades compatíveis ou use fontes separadas quando os públicos não puderem receber respostas de outras versões.
Verificação
Faça a mesma pergunta específica da versão em cada localidade indexada e verifique se todas as citações mantêm o prefixo de rota esperado.
Questão do Docusaurus
Widget ausente ou duplicado
Decisão de implementação
Verifique a chave da API, o ID do carregador, as mensagens de CSP no console, a resposta do script e se outro componente do tema também injeta o widget.
Verificação
Teste um build de produção, não apenas o hot reload, e inspecione os painéis Elements e Network após a navegação.
Verificação de resposta com citação

Teste uma resposta em que o caminho da versão é importante

Um teste de aceitação útil pergunta sobre uma configuração cuja resposta pode variar conforme a versão e depois abre a citação para verificar tanto a afirmação quanto a URL versionada.

Pergunte à documentação do Docusaurus
x
Como faço para abrir por padrão a documentação estável mais recente?
Na configuração do plugin de documentação, defina lastVersion como a versão que os visitantes devem abrir e use onlyIncludeVersions quando precisar limitar as versões publicadas. Mantenha a rota da documentação atual somente se quiser que os usuários acessem documentação ainda não lançada.
Faça uma pergunta...
Distribuído por ChattyBox
Resposta da ChattyBox sobre a versão padrão do Docusaurus com uma citação do guia de versionamento
Referência do resultado original: a resposta informa as configurações de versão relevantes e apresenta o guia oficial de versionamento como evidência.
Caminho de instalação

Como adicionar ChattyBox ao Docusaurus

Crie um componente Root do tema Docusaurus, adicione o script do widget depois que seus documentos forem rastreados e implante. Seus visitantes podem então fazer perguntas em qualquer página de documentos.

  1. 1Crie um projeto ChattyBox e insira o URL dos documentos do Docusaurus ou mapa do site.
  2. 2Teste perguntas reais do Docusaurus no painel e confirme se as citações apontam para as páginas certas.
  3. 3Adicione o script do widget em src/theme/Root.tsx para que ele seja carregado em seu site de documentação.
src/theme/Root.tsx
tsx
import React, { useEffect, type ReactNode } from 'react';

const WIDGET_ID = 'chattybox-widget';

export default function Root({ children }: { children: ReactNode }) {
  useEffect(() => {
    if (document.getElementById(WIDGET_ID)) return;

    const script = document.createElement('script');
    script.id = WIDGET_ID;
    script.src = 'https://chattybox.ai/widget.js';
    script.async = true;
    script.dataset.apiKey = 'YOUR_API_KEY';
    script.dataset.apiUrl = 'https://adorable-woodpecker-629.convex.site/chat';
    script.dataset.chattyboxWidget = 'true';
    document.body.appendChild(script);
  }, []);

  return <>{children}</>;
}
Perguntas frequentes

Perguntas comuns

1

ChattyBox pode rastrear um site Docusaurus?

Sim. ChattyBox pode rastrear páginas de documentação públicas Docusaurus ou usar um URL de mapa do site para descobrir o conteúdo dos documentos.

2

Preciso mudar meu tema Docusaurus?

Não. Você incorpora ChattyBox com uma tag de script, para que funcione junto com seu tema e implantação Docusaurus existentes.

3

As respostas direcionarão para as páginas Docusaurus?

Sim. As respostas podem incluir citações que direcionam os usuários às páginas de documentação exatas usadas para a resposta.

4

Posso testar o bot antes de instalá-lo?

Sim. Você pode testar o conteúdo rastreado no painel antes de copiar o snippet do widget para seu site Docusaurus.

Cadastre-se para testar nosso plano Free

Está avaliando o ChattyBox para uma organização? Entre em contato com o suporte para conversar sobre um período de teste de um plano mais completo.

We use optional analytics and tag-management tools to understand site use. Choose whether to allow Ahrefs Web Analytics, PostHog, and Google Tag Manager. Turning analytics off reloads this page so the change takes effect cleanly. Essential site functionality and error monitoring are not controlled by this choice. Read our privacy policy.