Kan ChattyBox een Docusaurus-site crawlen?
Ja. ChattyBox kan openbare Docusaurus-documentatiepagina’s crawlen of een sitemap-URL gebruiken om documentatiecontent te ontdekken.
Een Docusaurus AI-chatbot voor technische schrijvers, DevRel en supportteams. ChattyBox crawlt uw Docusaurus-documentatie, beantwoordt vragen zoals “Hoe configureer ik versiebeheer?” vanuit die pagina's en citeert de bron die hij gebruikte. Geen aangepaste RAG en geen migratie.
Evalueert u ChattyBox voor een organisatie? Neem contact op met support om een proefperiode voor een uitgebreider plan te bespreken.
Bij sommige AI-ondersteuningstools moet je een demo boeken voordat je het product zelfs maar kunt testen. ChattyBox is zelfbediening: voeg uw site toe, crawl uw documenten, test de chatbot en sluit deze in wanneer u klaar bent.
Traditionele AI-ondersteuningstools
Zelfbedieningsopstelling
ChattyBox crawlt uw bestaande website, documentatie, helpcentrum, CMS of kennisbank en sluit vervolgens een chatbot in die antwoord geeft op basis van uw eigen gepubliceerde inhoud in plaats van het generieke modelgeheugen.
Kies de productie-sitemap van Docusaurus of een bewuste set huidige, versiegebonden en gelokaliseerde documentatieroutes.
Crawl de geselecteerde routes en test vragen vervolgens tegen de exacte release en locale die uw bezoekers gebruiken.
Installeer één blijvende loader in src/theme/Root.tsx en sta de script- en API-origins ervan toe in uw Content Security Policy.
Navigeer zonder herladen tussen documentatiepagina’s en controleer één widgetinstantie, werkende bronvermeldingen en de afwezigheid van console- of CSP-fouten.
Lancering in drie stappen
Docusaurus rendert een blijvende React-applicatie rond routewijzigingen aan de clientzijde. De geteste Root-wrapper maakt daarom één loader, herkent latere mounts aan de ID en laat de loader staan in plaats van een nog actieve widget te verwijderen tijdens remounts in ontwikkeling.
Controleer de Root-levenscyclus, sitemapuitvoer en CSP-origins opnieuw na een grote Docusaurus-upgrade of wijziging van het widgetendpoint.
| Docusaurus-aandachtspunt | Implementatiebeslissing | Verificatie |
|---|---|---|
Docusaurus-aandachtspunt Root- en clientnavigatie | Implementatiebeslissing Maak het asynchrone script één keer aan met een stabiele ID. Retourneer geen cleanup vanuit het effect, omdat Root en de widget bedoeld zijn om tussen routes te blijven bestaan. | Verificatie Open twee interne documentatielinks en bevestig dat document.querySelectorAll("#chattybox-widget").length 1 is. |
Docusaurus-aandachtspunt Content Security Policy | Implementatiebeslissing Sta chattybox.ai toe in script-src, de geconfigureerde API-origin in connect-src, fonts.googleapis.com in style-src en fonts.gstatic.com in font-src. De huidige widget injecteert zijn eigen component-CSS, dus een strenge style-src heeft ook 'unsafe-inline' nodig totdat een nonce-bewuste of externe stylesheet-build beschikbaar is. | Verificatie Herlaad met DevTools geopend en bevestig dat er geen geblokkeerde script-, style-, font-, fetch- of WebSocket-verzoeken zijn. |
Docusaurus-aandachtspunt Versies, locales en sitemapscope | Implementatiebeslissing Inspecteer de geïmplementeerde sitemap voordat u crawlt. Neem alleen ondersteunde release- en localepaden op, of gebruik afzonderlijke bronnen wanneer doelgroepen geen antwoorden over andere versies mogen ontvangen. | Verificatie Stel in elke geïndexeerde locale dezelfde releasespecifieke vraag en controleer of elke bronvermelding het verwachte routeprefix behoudt. |
Docusaurus-aandachtspunt Ontbrekende of dubbele widget | Implementatiebeslissing Controleer de API-sleutel, loader-ID, CSP-consoleberichten, scriptrespons en of een andere themacomponent de widget ook injecteert. | Verificatie Test een productiebuild, niet alleen hot reload, en inspecteer na navigatie de panelen Elements en Network. |
Een nuttige acceptatietest vraagt naar een instelling waarvan het antwoord per release kan verschillen en opent vervolgens de bronvermelding om zowel de claim als de versiegebonden URL te verifiëren.
Maak een Docusaurus-thema Root-component, voeg het widgetscript toe nadat uw documenten zijn geschraapt en implementeer het. Uw bezoekers kunnen vervolgens vanaf elke documentenpagina vragen 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 kan openbare Docusaurus-documentatiepagina’s crawlen of een sitemap-URL gebruiken om documentatiecontent te ontdekken.
Nee. Je embedt ChattyBox met een scripttag, dus het werkt naast je bestaande Docusaurus-thema en deployment.
Ja. Antwoorden kunnen citaties bevatten die gebruikers terugsturen naar de exacte documentatiepagina’s die voor het antwoord zijn gebruikt.
Ja. Je kunt gescrapete content in het dashboard testen voordat je de widgetsnippet naar je Docusaurus-site kopieert.
Evalueert u ChattyBox voor een organisatie? Neem contact op met support om een proefperiode voor een uitgebreider plan te bespreken.
We use optional analytics and tag-management tools to understand site use. Choose whether to allow PostHog and Google Tag Manager. Turning analytics off reloads this page so the change takes effect cleanly. Essential site functionality and error monitoring are not controlled by this choice. Read our privacy policy.