Passa al contenuto principale
Supporto per la documentazione Docusaurus

Aggiungi un chatbot AI con citazioni delle fonti alla tua documentazione Docusaurus

Un chatbot IA per Docusaurus dedicato a technical writer, team DevRel e assistenza. ChattyBox esegue la scansione della documentazione Docusaurus e può inserire nelle risposte link alle pagine recuperate. Verifica l'accuratezza delle risposte e delle citazioni. Nessun sistema RAG personalizzato e nessuna migrazione.

Esegue la scansione delle pagine dei documenti pubblicatiRisposte con citazioni delle fontiIncorpora con uno scriptNon è richiesta la migrazione dei documentiNessuna carta di credito richiestaI tuoi contenuti restano tuoi
Chiedi a ChattyBox
Da dove dovrei iniziare se mi serve una risposta affidabile da questo sito?
Inizia aggiungendo l’URL pubblico del sito a ChattyBox. Recupera contenuti indicizzati per guidare le risposte e può mostrare link alle pagine fonte da verificare. Prova risposte e fallback prima del lancio.
iFonti3^
Docusaurus guida
chattybox.ai
Analisi
chattybox.ai
Pagina iniziale
chattybox.ai

Conversazione a scopo illustrativo — non è una chat dal vivo.

Offerto da ChattyBox
Configurazione self-service

Non è richiesta alcuna chiamata di vendita

Alcuni strumenti di supporto AI ti obbligano a prenotare una demo prima ancora di poter testare il prodotto. ChattyBox è self-service: aggiungi il tuo sito, esegui la scansione dei tuoi documenti, testa il chatbot e incorporalo quando sei pronto.

Strumenti tradizionali di supporto dell'intelligenza artificiale

  • Prenota una dimostrazione
  • Prezzi nascosti o guidati dalle vendite
  • Concentrato sull'impresa
  • Prima la conversazione sulle vendite

Configurazione self-service

ChattyBox

  • Inizia subito
  • Prezzi pubblici
  • Creato per siti di documenti, piccoli team, OSS e SaaS
  • Provalo tu stesso prima

Lancia un chatbot con citazioni delle fonti senza ricostruire lo stack del tuo sito

ChattyBox esegue la scansione del tuo sito web esistente, della documentazione, del centro assistenza, del CMS o della knowledge base. I contenuti recuperati possono guidare le risposte del chatbot; verifica l'accuratezza delle risposte e delle citazioni.

Un wrapper Root di Docusaurus 3 carica il widget una sola volta per l'intera durata dell'applicazione client.
L'ambito della scansione può seguire percorsi della documentazione correnti, con versioni, localizzati o filtrati intenzionalmente.
Le citazioni possono rimandare i lettori alle pagine Docusaurus recuperate. Verifica la risposta e il percorso della versione e della lingua.
L'esempio riproducibile copre la prevenzione dei duplicati, la navigazione client, la CSP e la verifica a livello di percorso.
Passaggio del workflow

Scegli la sitemap Docusaurus di produzione o un insieme intenzionale di percorsi della documentazione correnti, con versioni e localizzati.

Passaggio del workflow

Esegui la scansione dei percorsi selezionati, quindi verifica le domande sulla release e sulla lingua esatte usate dai visitatori.

Passaggio del workflow

Installa un unico loader persistente in src/theme/Root.tsx e consenti le origini del relativo script e dell'API nella Content Security Policy.

Passaggio del workflow

Naviga tra le pagine della documentazione senza ricaricarle e verifica che ci siano una sola istanza del widget, citazioni funzionanti e nessun errore nella console o della CSP.

Lancio in tre fasi

Incolla l'URL Docusaurus, prova le risposte con citazioni delle fonti, quindi installa il widget.

Evidenze editoriali verificate

Un'integrazione Docusaurus 3 verificata, non uno script a livello di percorso

Docusaurus esegue il rendering di un'applicazione React persistente durante i cambi di percorso lato client. Il wrapper Root verificato crea quindi un solo loader, riconosce i montaggi successivi tramite ID e lascia il loader in posizione anziché rimuovere un widget ancora attivo durante i nuovi montaggi in sviluppo.

Autore tecnico
Team di documentazione ChattyBox
Revisore tecnico
ChattyBox Ingegneria
Ultimo aggiornamento
Informazioni verificate
Docusaurus 3.10 e widget ChattyBox corrente

Ricontrolla il ciclo di vita di Root, l'output della sitemap e le origini CSP dopo un aggiornamento principale di Docusaurus o una modifica dell'endpoint del widget.

Componente Root di Docusaurus che impedisce la duplicazione dello script ChattyBox dopo la navigazione client
Riferimento originale per l'installazione: il loader ha un ID stabile, viene caricato in modo asincrono e resta presente mentre Docusaurus cambia percorso.
Docusaurus 3 decisioni di installazione e relativi controlli end-to-end.
Preoccupazione DocusaurusDecisione di attuazioneVerifica
Preoccupazione Docusaurus
Root e navigazione client
Decisione di attuazione
Crea lo script asincrono una sola volta usando un ID stabile. Non restituire una funzione di pulizia dall'effetto, perché Root e il widget sono destinati a persistere tra i percorsi.
Verifica
Apri due collegamenti a documenti interni e conferma che document.querySelectorAll("#chattybox-widget").length è 1.
Preoccupazione Docusaurus
Content Security Policy
Decisione di attuazione
Consenti chattybox.ai in script-src, l'origine API configurata in connect-src, fonts.googleapis.com in style-src e fonts.gstatic.com in font-src. Il widget attuale inietta il CSS del componente, quindi uno style-src restrittivo richiede anche 'unsafe-inline' finché non sarà disponibile una build con nonce o con un foglio di stile esterno.
Verifica
Ricarica con DevTools aperto e conferma che non ci sono richieste di script, stile, font, fetch o WebSocket bloccate.
Preoccupazione Docusaurus
Versioni, impostazioni locali e ambito della mappa del sito
Decisione di attuazione
Esamina la sitemap pubblicata prima della scansione. Includi solo i percorsi delle versioni e delle lingue supportate. Per ambiti di versione separati, usa progetti separati contenenti solo le pagine previste per ciascuno e verifica che le risposte non mescolino versioni diverse.
Verifica
Poni la stessa domanda specifica per la versione in ogni locale indicizzata e controlla che ogni citazione mantenga il prefisso di percorso previsto.
Preoccupazione Docusaurus
Widget mancante o duplicato
Decisione di attuazione
Controlla la chiave API, l'ID del caricatore, i messaggi della console CSP, la risposta dello script e se anche un altro componente del tema inserisce il widget.
Verifica
Testa una build di produzione, non solo la ricarica a caldo, e ispeziona i pannelli Elements e Network dopo la navigazione.
Controllo della risposta citata

Testare una risposta in cui è importante il percorso di rilascio

Un utile test di accettazione chiede informazioni su un'impostazione la cui risposta può differire in base alla versione, quindi apre la citazione per verificare sia l'affermazione che l'URL con versione.

Lista di controllo pratica per valutare i chatbot IA per la documentazione
Chiedi ai documenti Docusaurus
Come faccio ad aprire per impostazione predefinita gli ultimi documenti stabili?
Nella configurazione del plug-in dei documenti, imposta lastVersion sulla versione che i visitatori dovrebbero aprire e utilizza onlyIncludeVersions quando è necessario limitare le versioni pubblicate. Mantieni il percorso corrente dei documenti solo se desideri che gli utenti accedano alla documentazione non rilasciata.

Conversazione a scopo illustrativo — non è una chat dal vivo.

Offerto da ChattyBox
Risposta di ChattyBox sulla versione Docusaurus predefinita con una citazione della guida al controllo delle versioni
Riferimento al risultato originale: la risposta nomina le impostazioni della versione rilevanti ed espone la guida ufficiale al controllo delle versioni come prova.
Percorso di installazione

Come aggiungere ChattyBox a Docusaurus

Crea un componente Root del tema Docusaurus, aggiungi lo script del widget dopo la scansione della documentazione e pubblica il sito. I visitatori potranno quindi porre domande da qualsiasi pagina della documentazione.

  1. 1Crea un progetto ChattyBox e inserisci l'URL dei documenti o la mappa del sito di Docusaurus.
  2. 2Prova le domande reali di Docusaurus nella dashboard e verifica che le citazioni indirizzino alle pagine giuste.
  3. 3Aggiungi lo script del widget in src/theme/Root.tsx in modo che venga caricato nel tuo sito di documentazione.
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}</>;
}
Domande frequenti

Domande comuni

1

ChattyBox può eseguire la scansione di un sito Docusaurus?

Sì. ChattyBox può eseguire la scansione delle pagine di documentazione pubbliche Docusaurus o utilizzare un URL della mappa del sito per scoprire il contenuto dei documenti.

2

Devo cambiare il mio tema Docusaurus?

No. Incorpori ChattyBox con un tag script, quindi funziona insieme al tema e alla distribuzione Docusaurus esistenti.

3

Le risposte rimanderanno alle pagine Docusaurus?

Le risposte possono contenere link alle pagine della documentazione recuperate, ma le risposte di fallback potrebbero non avere fonti. Verifica l'accuratezza delle risposte e delle citazioni.

4

Posso testare il bot prima di installarlo?

Sì. Puoi testare il contenuto prelevato nella dashboard prima di copiare lo snippet del widget sul tuo sito Docusaurus.