Kann ChattyBox eine Docusaurus-Website crawlen?
Ja. ChattyBox kann öffentliche Docusaurus-Dokumentationsseiten crawlen oder eine Sitemap-URL nutzen, um Docs-Inhalte zu finden.
Ein Docusaurus-KI-Chatbot für technische Autoren, DevRel und Support-Teams. ChattyBox crawlt Ihre Docusaurus-Dokumentation und kann in Antworten auf abgerufene Seiten verlinken. Prüfen Sie Antworten und Quellenangaben auf Richtigkeit. Kein benutzerdefiniertes RAG und keine Migration.
Bei einigen KI-Support-Tools müssen Sie eine Demo buchen, bevor Sie das Produkt überhaupt testen können. ChattyBox ist eine Selbstbedienungslösung: Fügen Sie Ihre Website hinzu, crawlen Sie Ihre Dokumente, testen Sie den Chatbot und betten Sie ihn ein, wenn Sie bereit sind.
Traditionelle KI-Unterstützungstools
Selbstbedienungseinrichtung
ChattyBox crawlt Ihre bestehende Website, Dokumentation, Ihr Help Center, CMS oder Ihre Wissensdatenbank. Abgerufene Inhalte können als Grundlage für die Antworten des Chatbots dienen; prüfen Sie Antworten und Quellenangaben auf ihre Richtigkeit.
Wählen Sie die produktive Docusaurus-Sitemap oder eine gezielt zusammengestellte Menge aktueller, versionierter und lokalisierter Dokumentationsrouten.
Crawlen Sie die ausgewählten Routen und testen Sie Fragen anschließend mit genau der Version und Sprache, die Ihre Besuchenden verwenden.
Installieren Sie einen dauerhaften Loader in src/theme/Root.tsx und erlauben Sie dessen Skript- und API-Ursprünge in Ihrer Content Security Policy.
Navigieren Sie ohne Neuladen zwischen Dokumentationsseiten und prüfen Sie, dass genau eine Widget-Instanz vorhanden ist, Quellenangaben funktionieren und keine Konsolen- oder CSP-Fehler auftreten.
Dreistufiger Start
Docusaurus rendert eine dauerhafte React-Anwendung um clientseitige Routenwechsel. Der getestete Root-Wrapper erstellt daher genau einen Loader, erkennt spätere Einbindungen anhand der ID und belässt den Loader an Ort und Stelle, statt bei erneuten Einbindungen während der Entwicklung ein noch aktives Widget zu entfernen.
Prüfen Sie nach einem Hauptversionsupgrade von Docusaurus oder einer Änderung des Widget-Endpunkts den Root-Lebenszyklus, die Sitemap-Ausgabe und die CSP-Ursprünge erneut.
| Docusaurus-Aspekt | Implementierungsentscheidung | Überprüfung |
|---|---|---|
Docusaurus-Aspekt Root und Clientnavigation | Implementierungsentscheidung Erstellen Sie das asynchrone Skript anhand einer stabilen ID genau einmal. Geben Sie aus dem Effekt keine Bereinigungsfunktion zurück, da Root und Widget über Routen hinweg bestehen bleiben sollen. | Überprüfung Öffnen Sie zwei interne Dokumentationslinks und bestätigen Sie, dass document.querySelectorAll("#chattybox-widget").length den Wert 1 hat. |
Docusaurus-Aspekt Content Security Policy | Implementierungsentscheidung Erlauben Sie chattybox.ai in script-src, den konfigurierten API-Ursprung in connect-src, fonts.googleapis.com in style-src und fonts.gstatic.com in font-src. Das aktuelle Widget fügt sein Komponenten-CSS ein, daher benötigt eine strenge style-src-Richtlinie zusätzlich 'unsafe-inline', bis ein Nonce-basierter oder externer Stylesheet-Build verfügbar ist. | Überprüfung Laden Sie mit geöffneten DevTools neu und bestätigen Sie, dass keine Skript-, Stil-, Schrift-, Fetch- oder WebSocket-Anfragen blockiert werden. |
Docusaurus-Aspekt Versionen, Sprachen und Sitemap-Umfang | Implementierungsentscheidung Prüfen Sie vor dem Crawlen die bereitgestellte Sitemap. Nehmen Sie nur unterstützte Versions- und Sprachpfade auf. Verwenden Sie für getrennte Versionsbereiche separate Projekte, die jeweils nur die vorgesehenen Seiten enthalten, und testen Sie auf versionsübergreifende Antworten. | Überprüfung Stellen Sie in jeder indizierten Sprache dieselbe versionsspezifische Frage und prüfen Sie, dass jede Quellenangabe das erwartete Routenpräfix beibehält. |
Docusaurus-Aspekt Fehlendes oder doppeltes Widget | Implementierungsentscheidung Prüfen Sie API-Schlüssel, Loader-ID, CSP-Konsolenmeldungen, Skriptantwort und ob eine andere Theme-Komponente das Widget ebenfalls einfügt. | Überprüfung Testen Sie einen Produktionsbuild und nicht nur Hot Reload und prüfen Sie nach der Navigation die Bereiche Elements und Network. |
Ein nützlicher Akzeptanztest fragt nach einer Einstellung, deren Antwort je nach Version abweichen kann, und öffnet anschließend die Quellenangabe, um sowohl die Aussage als auch die versionierte URL zu prüfen.
Praktische Checkliste zur Bewertung von KI-Chatbots für DokumentationErstellen Sie eine Root-Komponente für das Docusaurus-Theme, fügen Sie das Widget-Skript hinzu, nachdem Ihre Dokumente gescrapt wurden, und stellen Sie es bereit. Ihre Besucher können dann von jeder Dokumentenseite aus Fragen stellen.
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 kann öffentliche Docusaurus-Dokumentationsseiten crawlen oder eine Sitemap-URL nutzen, um Docs-Inhalte zu finden.
Nein. Sie betten ChattyBox mit einem Script-Tag ein, sodass es neben Ihrem bestehenden Docusaurus-Theme und Deployment funktioniert.
Antworten können auf abgerufene Dokumentationsseiten verlinken, aber Fallback-Antworten haben möglicherweise keine Quellen. Prüfen Sie Antworten und Quellenangaben auf Richtigkeit.
Ja. Sie können gescrapte Inhalte im Dashboard testen, bevor Sie das Widget-Snippet auf Ihre Docusaurus-Website kopieren.