Kan ChattyBox crawla en Docusaurus-webbplats?
Ja. ChattyBox kan crawla offentliga Docusaurus-dokumentationssidor eller använda en sitemap-URL för att hitta docs-innehåll.
En Docusaurus AI-chattbot för tekniska skribenter, DevRel och supportteam. ChattyBox genomsöker din Docusaurus-dokumentation och kan länka svar till hämtade sidor. Kontrollera att svar och källhänvisningar är korrekta. Ingen egen RAG och ingen migrering.
Vissa AI-stödverktyg gör att du bokar en demo innan du ens kan testa produkten. ChattyBox är självbetjäning: lägg till din webbplats, genomsök dina dokument, testa chatboten och bädda in den när du är redo.
Traditionella AI-stödverktyg
Självbetjäningsinställning
ChattyBox genomsöker din befintliga webbplats, dokumentation, ditt hjälpcenter, CMS eller din kunskapsbas. Hämtat innehåll kan vägleda chatbotens svar; kontrollera att svaren och källhänvisningarna är korrekta.
Välj produktionswebbplatskartan för Docusaurus eller en avsiktlig uppsättning aktuella, versionerade och lokaliserade dokumentrutter.
Genomsök de valda rutterna och testa sedan frågor mot den exakta versionen och lokaliseringen som dina besökare använder.
Installera en beständig laddare i src/theme/Root.tsx och tillåt skriptets och API:ets ursprung i webbplatsens innehållssäkerhetspolicy.
Navigera mellan dokumentsidor utan omladdning och verifiera en widgetinstans, fungerande citat och inga konsol- eller CSP-fel.
Lansering i tre steg
Docusaurus renderar en beständig React-applikation kring ruttändringar på klientsidan. Den testade Root-komponenten skapar därför en laddare, känner igen den via dess ID vid senare monteringar och lämnar den på plats i stället för att ta bort en fortfarande aktiv widget vid ommontering under utveckling.
Kontrollera Root-livscykeln, webbplatskartans utdata och CSP-ursprungen igen efter en större Docusaurus-uppgradering eller en ändring av widgetens endpoint.
| Docusaurus-aspekt | Implementeringsbeslut | Kontroll |
|---|---|---|
Docusaurus-aspekt Root och klientnavigering | Implementeringsbeslut Skapa det asynkrona skriptet en gång med ett stabilt ID. Returnera ingen rensningsfunktion från effekten eftersom Root och widgeten ska finnas kvar mellan rutter. | Kontroll Öppna två interna dokumentationslänkar och bekräfta att document.querySelectorAll("#chattybox-widget").length är 1. |
Docusaurus-aspekt Innehållssäkerhetspolicy | Implementeringsbeslut Tillåt chattybox.ai i script-src, det konfigurerade API-ursprunget i connect-src, fonts.googleapis.com i style-src och fonts.gstatic.com i font-src. Den aktuella widgeten injicerar sin komponent-CSS, så en strikt style-src behöver även 'unsafe-inline' tills en nonce-medveten eller extern stilmallsbyggnad är tillgänglig. | Kontroll Ladda om med DevTools öppen och bekräfta att det inte finns några blockerade skript-, stil-, typsnitts-, hämtnings- eller WebSocket-förfrågningar. |
Docusaurus-aspekt Versioner, språkinställningar och webbplatskartor | Implementeringsbeslut Inspektera den publicerade webbplatskartan innan den genomsöks. Inkludera endast sökvägar för versioner och språk som stöds. För separata versionsomfång, använd separata projekt med endast de avsedda sidorna i varje projekt och testa om svar hämtas från andra versioner. | Kontroll Ställ samma versionsspecifika fråga på varje indexerat språk och kontrollera att varje källhänvisning behåller det förväntade ruttprefixet. |
Docusaurus-aspekt Widget saknas eller visas dubbelt | Implementeringsbeslut Kontrollera API-nyckeln, laddar-ID, CSP-konsolmeddelanden, skriptsvar och om en annan temakomponent också injicerar widgeten. | Kontroll Testa en produktionsbyggnad, inte bara omladdning, och inspektera panelerna Elements och Network efter navigering. |
Ett användbart godkännandetest frågar om en inställning vars svar kan skilja sig mellan versioner och öppnar sedan källhänvisningen för att verifiera både påståendet och den versionerade URL:en.
Praktisk checklista för att utvärdera AI-chattbotar för dokumentationSkapa en rotkomponent för Docusaurus-tema, lägg till widgetskriptet efter att dina dokument har skrapats och distribuera. Dina besökare kan sedan ställa frågor från vilken dokumentsida som helst.
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}</>;
}Ja. ChattyBox kan crawla offentliga Docusaurus-dokumentationssidor eller använda en sitemap-URL för att hitta docs-innehåll.
Nej. Du bäddar in ChattyBox med en skripttagg, så den fungerar bredvid ditt befintliga Docusaurus-tema och din deployment.
Svar kan länka till hämtade dokumentationssidor, men reservsvar kan sakna källor. Kontrollera att svar och källhänvisningar är korrekta.
Ja. Du kan testa det insamlade innehållet i instrumentpanelen innan du kopierar widgetkoden till din Docusaurus-webbplats.