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.
Trasforma i tuoi documenti Docusaurus in un assistente di supporto AI che cita le pagine esatte utilizzate. Mantieni lo stack dei tuoi documenti, aggiungi un widget incorporabile.
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.
ChattyBox esegue la scansione della documentazione esistente, indicizza il contenuto per il recupero e incorpora un chatbot che risponde utilizzando i tuoi documenti anziché la memoria del modello generico.
Scegli la sitemap Docusaurus di produzione o un insieme intenzionale di percorsi della documentazione correnti, con versioni e localizzati.
Esegui la scansione dei percorsi selezionati, quindi verifica le domande sulla release e sulla lingua esatte usate dai visitatori.
Installa un unico loader persistente in src/theme/Root.tsx e consenti le origini del relativo script e dell'API nella Content Security Policy.
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
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.
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.
| Preoccupazione Docusaurus | Decisione di attuazione | Verifica |
|---|---|---|
| Root e navigazione client | Crea lo script asincrono una volta in base all'ID stabile. Non restituire la pulizia dall'effetto perché Root e il widget sono destinati a persistere attraverso i percorsi. | Apri due collegamenti a documenti interni e conferma che document.querySelectorAll("#chattybox-widget").length è 1. |
| Content Security Policy | 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. | Ricarica con DevTools aperto e conferma che non ci sono richieste di script, stile, font, fetch o WebSocket bloccate. |
| Versioni, impostazioni locali e ambito della mappa del sito | Ispeziona la mappa del sito distribuita prima della scansione. Includi solo percorsi di versione e impostazioni locali supportati oppure utilizza fonti separate quando il pubblico non deve ricevere risposte a più versioni. | Poni la stessa domanda specifica per la versione in ogni locale indicizzata e controlla che ogni citazione mantenga il prefisso di percorso previsto. |
| Widget mancante o duplicato | 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. | Testa una build di produzione, non solo la ricarica a caldo, e ispeziona i pannelli Elements e Network dopo la navigazione. |
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.
Crea un componente root del tema Docusaurus, aggiungi lo script del widget dopo che i tuoi documenti sono stati raschiati e distribuisci. I tuoi visitatori potranno quindi porre domande da qualsiasi pagina di documenti.
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}</>;
}Scopri come funzionano le risposte citate alla fonte nei siti e nelle piattaforme di documentazione tecnica.
Aiuta gli sviluppatori a risolvere più rapidamente le domande su configurazione, SDK, API ed errori dalle tue guide.
Confronta lo stesso flusso di lavoro citato nella fonte per i siti MkDocs e Material for MkDocs.
Trova guide di configurazione per VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo e altre piattaforme di documentazione.
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.
No. Incorpori ChattyBox con un tag script, quindi funziona insieme al tema e alla distribuzione Docusaurus esistenti.
Sì. Le risposte possono includere citazioni che rimandano gli utenti alle esatte pagine della documentazione utilizzate per la risposta.
Sì. Puoi testare il contenuto prelevato nella dashboard prima di copiare lo snippet del widget sul tuo sito Docusaurus.
Nessuna carta di credito richiesta. I tuoi contenuti non vengono usati per addestrare modelli.
Piano Free. Nessuna carta.