Ga naar de hoofdinhoud
Docusaurus-documentatiesupport

Voeg een AI-chatbot met bronvermeldingen toe aan je Docusaurus-documentatie

Een Docusaurus AI-chatbot voor technische schrijvers, DevRel en supportteams. ChattyBox crawlt je Docusaurus-documentatie en kan antwoorden linken aan opgehaalde pagina’s. Controleer antwoorden en bronvermeldingen op juistheid. Geen aangepaste RAG en geen migratie.

Crawlt gepubliceerde documentatiepagina'sAntwoorden met bronvermeldingenIngesloten met één scriptGeen documentatiemigratie vereistGeen creditcard vereistJe content blijft van jou
Vraag ChattyBox
Waar moet ik beginnen als ik een betrouwbaar antwoord van deze site nodig heb?
Voeg eerst uw openbare website-URL toe aan ChattyBox. Het haalt geïndexeerde inhoud op om antwoorden te sturen en kan bronlinks tonen ter controle. Test antwoorden en terugvalantwoorden vóór de lancering.
iBronnen3^
Docusaurus gids
chattybox.ai
Analyse
chattybox.ai
Startpagina
chattybox.ai

Illustratief gesprek — geen livechat.

Aangedreven door ChattyBox
Zelfbedieningsopstelling

Geen verkoopgesprek vereist

Bij sommige AI-ondersteuningstools moet je een demo boeken voordat je het product zelfs maar kunt testen. ChattyBox is selfservice: voeg je site toe, crawl je documentatie, test de chatbot en sluit deze in wanneer je klaar bent.

Traditionele AI-ondersteuningstools

  • Boek een demo
  • Prijzen verborgen of verkoopgestuurd
  • Ondernemingsgericht
  • Eerst een verkoopgesprek

Zelfbedieningsopstelling

ChattyBox

  • Begin meteen
  • Openbare prijzen
  • Gebouwd voor documentatiesites, kleine teams, OSS en SaaS
  • Test het eerst zelf

Start een chatbot met bronvermeldingen zonder uw website-stack opnieuw op te bouwen

ChattyBox crawlt uw bestaande website, documentatie, helpcentrum, CMS of kennisbank. Opgehaalde inhoud kan de antwoorden van de chatbot sturen; controleer antwoorden en bronvermeldingen op juistheid.

Een Docusaurus 3 Root-wrapper laadt de widget één keer voor de levensduur van de clientapplicatie.
De crawlscope kan huidige, versiegebonden, gelokaliseerde of bewust gefilterde documentatieroutes volgen.
Bronvermeldingen kunnen lezers naar opgehaalde Docusaurus-pagina’s linken. Controleer het antwoord en het versie- en localepad.
Het reproduceerbare voorbeeld behandelt het voorkomen van duplicaten, clientnavigatie, CSP en verificatie op routeniveau.
Workflowstap

Kies de productie-sitemap van Docusaurus of een bewuste set huidige, versiegebonden en gelokaliseerde documentatieroutes.

Workflowstap

Crawl de geselecteerde routes en test vragen vervolgens tegen de exacte release en locale die uw bezoekers gebruiken.

Workflowstap

Installeer één blijvende loader in src/theme/Root.tsx en sta de script- en API-origins ervan toe in uw Content Security Policy.

Workflowstap

Navigeer zonder herladen tussen documentatiepagina’s en controleer één widgetinstantie, werkende bronvermeldingen en de afwezigheid van console- of CSP-fouten.

Lancering in drie stappen

Plak de URL van Docusaurus, test antwoorden met bronvermeldingen en installeer vervolgens de widget.

Getoetst redactioneel bewijs

Een geteste Docusaurus 3-integratie, geen script op routeniveau

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.

Technisch auteur
ChattyBox-documentatieteam
Technisch reviewer
ChattyBox-engineeringteam
Laatst bijgewerkt
Informatie gecontroleerd
Docusaurus 3.10 en de huidige ChattyBox-widget

Controleer de Root-levenscyclus, sitemapuitvoer en CSP-origins opnieuw na een grote Docusaurus-upgrade of wijziging van het widgetendpoint.

Docusaurus Root-component dat na clientnavigatie een dubbel ChattyBox-script voorkomt
Oorspronkelijke installatiereferentie: de loader heeft een stabiele ID, laadt asynchroon en blijft aanwezig terwijl Docusaurus van route wisselt.
Installatiebeslissingen voor Docusaurus 3 en de bijbehorende end-to-endcontroles.
Docusaurus-aandachtspuntImplementatiebeslissingVerificatie
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 je crawlt. Neem alleen ondersteunde release- en localepaden op. Gebruik voor afzonderlijke versiebereiken afzonderlijke projecten met alleen de bedoelde pagina’s in elk project en test op antwoorden uit andere versies.
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.
Controle van antwoord met bronvermelding

Test een antwoord waarbij het releasepad van belang is

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.

Praktische evaluatiechecklist voor AI-documentatiechatbots
Stel een vraag aan de Docusaurus-documentatie
Hoe zorg ik dat de nieuwste stabiele documentatie standaard wordt geopend?
Stel in de configuratie van de docs-plug-in lastVersion in op de versie die bezoekers moeten openen en gebruik onlyIncludeVersions wanneer u gepubliceerde releases wilt beperken. Behoud de huidige docs-route alleen als u gebruikers toegang wilt geven tot niet-uitgebrachte documentatie.

Illustratief gesprek — geen livechat.

Aangedreven door ChattyBox
ChattyBox-antwoord over de standaardversie van Docusaurus met een bronvermelding naar de versiebeheergids
Oorspronkelijke resultaatreferentie: het antwoord noemt de relevante versie-instellingen en toont de officiële versiebeheergids als bewijs.
Installatiepad

Hoe ChattyBox aan Docusaurus toe te voegen

Maak een Root-component voor het Docusaurus-thema, voeg het widgetscript toe nadat uw documentatie is gecrawld en publiceer de site. Uw bezoekers kunnen vervolgens vanaf elke documentatiepagina vragen stellen.

  1. 1Maak een ChattyBox-project en voer de URL of sitemap van uw Docusaurus-documentatie in.
  2. 2Test echte Docusaurus-vragen in het dashboard en controleer of de bronvermeldingen naar de juiste pagina's verwijzen.
  3. 3Voeg het widgetscript toe in src/theme/Root.tsx zodat het op uw documentatiesite wordt geladen.
src/theme/Root.tsx
tsx
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}</>;
}
Veelgestelde vragen

Veelgestelde vragen

1

Kan ChattyBox een Docusaurus-site crawlen?

Ja. ChattyBox kan openbare Docusaurus-documentatiepagina’s crawlen of een sitemap-URL gebruiken om documentatiecontent te ontdekken.

2

Moet ik mijn Docusaurus-thema wijzigen?

Nee. Je embedt ChattyBox met een scripttag, dus het werkt naast je bestaande Docusaurus-thema en deployment.

3

Linken antwoorden terug naar Docusaurus-pagina’s?

Antwoorden kunnen linken naar opgehaalde documentatiepagina’s, maar terugvalantwoorden hebben mogelijk geen bronnen. Controleer antwoorden en bronvermeldingen op juistheid.

4

Kan ik de bot testen voordat ik hem installeer?

Ja. Je kunt gescrapete content in het dashboard testen voordat je de widgetsnippet naar je Docusaurus-site kopieert.