Pular para o conteúdo principal
Suporte para documentação Docusaurus

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

Um chatbot de IA para Docusaurus destinado a redatores técnicos, DevRel e equipas de suporte. O ChattyBox recolhe conteúdo da sua documentação Docusaurus e pode incluir nas respostas ligações para as páginas obtidas. Verifique a exatidão das respostas e citações. Sem RAG personalizado e sem migração.

Recolhe conteúdo de páginas de documentação publicadasRespostas com citações de fontesIncorpora com um scriptNão é necessário migrar a documentaçãoNão é necessário cartão de créditoO seu conteúdo continua a ser seu
Pergunte ao ChattyBox
Por onde devo começar se precisar de uma resposta fiável deste site?
Comece por adicionar o URL público do seu site ao ChattyBox. Este recupera conteúdo indexado para orientar as respostas e pode apresentar ligações às páginas de origem para os visitantes consultarem. Teste as respostas e as respostas alternativas antes do lançamento.
iFontes3^
Docusaurus guia
chattybox.ai
Análises
chattybox.ai
Início
chattybox.ai

Conversa ilustrativa — não é um chat em direto.

Disponibilizado pelo ChattyBox
Configuração de autoatendimento

Sem necessidade de falar com a equipa comercial

Algumas ferramentas de suporte com IA exigem que marque uma demonstração antes sequer de testar o produto. O ChattyBox é de utilização autónoma: adicione o seu site, recolha o conteúdo da documentação, teste o chatbot e incorpore-o quando estiver pronto.

Ferramentas tradicionais de suporte de IA

  • Marque uma demonstração
  • Preços ocultos ou baseados em vendas
  • Focado em grandes empresas
  • Conversa de vendas primeiro

Configuração de autoatendimento

ChattyBox

  • Comece imediatamente
  • Preços públicos
  • Criado para sites de documentação, pequenas equipas, OSS e SaaS
  • Teste primeiro por si próprio

Lance um chatbot com citações de fontes sem reconstruir a infraestrutura do seu site

O ChattyBox recolhe o conteúdo do seu site, documentação, centro de ajuda, CMS ou base de conhecimento existentes. O conteúdo recuperado pode orientar as respostas do chatbot; verifique a precisão das respostas e das citações.

Um wrapper Root do Docusaurus 3 carrega o widget uma única vez durante todo o ciclo de vida da aplicação cliente.
O âmbito da recolha pode seguir rotas de documentação atuais, versionadas, localizadas ou deliberadamente filtradas.
As citações podem encaminhar os leitores para as páginas Docusaurus obtidas. Verifique a resposta e o caminho da versão e do idioma.
O exemplo reproduzível abrange a prevenção de duplicados, a navegação no cliente, a CSP e a verificação por rota.
Etapa 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.

Etapa do fluxo de trabalho

Recolha o conteúdo das rotas selecionadas e depois teste as perguntas na versão e no idioma exatos usados pelos visitantes.

Etapa 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.

Etapa do fluxo de trabalho

Navegue entre as páginas da documentação sem recarregar e verifique se existe uma única instância do widget, se as citações funcionam e se não há erros na consola ou de CSP.

Lançamento em três etapas

Cole o URL de Docusaurus, teste as respostas com citações 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
Equipa de documentação do ChattyBox
Revisor técnico
Equipa de engenharia do ChattyBox
Última atualização
Informações verificadas
Docusaurus 3.10 e widget atual do 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 publicado antes da recolha. Inclua apenas caminhos de versões e idiomas suportados. Para âmbitos de versão separados, use projetos separados com apenas as páginas pretendidas em cada um e teste se existem respostas de outras versões.
Verificação
Faça a mesma pergunta específica da versão em cada idioma indexado 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.

Lista prática de avaliação de chatbots de IA para documentação
Pergunte à documentação do Docusaurus
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 de limitar as versões publicadas. Mantenha a rota da documentação atual apenas se quiser que os utilizadores acedam a documentação ainda não lançada.

Conversa ilustrativa — não é um chat em direto.

Disponibilizado pelo 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 de recolher o conteúdo da documentação e publique o site. Os visitantes podem então fazer perguntas em qualquer página da documentação.

  1. 1Crie um projeto no ChattyBox e introduza o URL da documentação Docusaurus ou do respetivo sitemap.
  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 seja carregado em todo o 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

O ChattyBox pode recolher conteúdo de um site Docusaurus?

Sim. O ChattyBox pode recolher conteúdo de páginas públicas de documentação Docusaurus ou usar o URL de um sitemap para descobrir conteúdo da documentação.

2

Preciso de alterar o meu tema Docusaurus?

Não. O ChattyBox é incorporado com uma etiqueta de script, pelo que funciona com o tema e a implementação Docusaurus existentes.

3

As respostas incluem ligações para as páginas Docusaurus?

As respostas podem incluir ligações para as páginas de documentação obtidas, mas as respostas de recurso podem não ter fontes. Verifique a exatidão das respostas e citações.

4

Posso testar o bot antes de o instalar?

Sim. Pode testar o conteúdo recolhido no painel antes de copiar o snippet do widget para o seu site Docusaurus.