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.
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.
ChattyBox crawlt je bestaande documentatie, indexeert de content voor retrieval en embedt een chatbot die antwoordt vanuit je documentatie in plaats van generiek 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 |
|---|---|---|
| Root- en clientnavigatie | 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. | Open twee interne documentatielinks en bevestig dat document.querySelectorAll("#chattybox-widget").length 1 is. |
| Content Security Policy | 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. | Herlaad met DevTools geopend en bevestig dat er geen geblokkeerde script-, style-, font-, fetch- of WebSocket-verzoeken zijn. |
| Versies, locales en sitemapscope | 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. | Stel in elke geïndexeerde locale dezelfde releasespecifieke vraag en controleer of elke bronvermelding het verwachte routeprefix behoudt. |
| Ontbrekende of dubbele widget | Controleer de API-sleutel, loader-ID, CSP-consoleberichten, scriptrespons en of een andere themacomponent de widget ook injecteert. | 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}</>;
}Ontdek hoe door de bron geciteerde antwoorden werken op technische documentatiesites en -platforms.
Help ontwikkelaars installatie-, SDK-, API- en foutvragen uit uw handleidingen sneller op te lossen.
Vergelijk dezelfde, door de bron geciteerde workflow voor MkDocs en Material for MkDocs-sites.
Vind installatiehandleidingen voor VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo en meer documentplatforms.
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.
Geen creditcard vereist. Je content wordt niet gebruikt voor modeltraining.
Gratis niveau. Geen kaart nodig.