ChattyBox peut-il explorer un site Docusaurus ?
Oui. ChattyBox peut explorer des pages publiques de documentation Docusaurus ou utiliser une URL de sitemap pour découvrir le contenu des docs.
Transformez vos docs Docusaurus en assistant de support IA qui cite les pages exactes utilisées. Gardez votre stack de docs et ajoutez un widget intégrable.
Certains outils de support d'IA vous obligent à réserver une démo avant même de pouvoir tester le produit. ChattyBox est en libre-service : ajoutez votre site, explorez vos documents, testez le chatbot et intégrez-le lorsque vous êtes prêt.
ChattyBox explore votre documentation existante, indexe le contenu pour la recherche et intègre un chatbot qui répond avec vos docs plutôt qu’avec la mémoire générique du modèle.
Choisissez le plan de site Docusaurus de production ou un ensemble délibéré de routes de documentation actuelles, versionnées et localisées.
Explorez les routes sélectionnées, puis testez les questions avec la version et la langue exactes qu'utilisent vos visiteurs.
Installez un chargeur persistant unique dans src/theme/Root.tsx et autorisez les origines de son script et de son API dans votre Content Security Policy.
Naviguez entre les pages de documentation sans rechargement et vérifiez qu'il n'existe qu'une instance du widget, que les citations fonctionnent et qu'aucune erreur de console ou de CSP ne se produit.
Un lancement en trois étapes
Docusaurus affiche une application React persistante autour des changements de route côté client. Le wrapper Root testé crée donc un chargeur unique, reconnaît les montages ultérieurs grâce à leur ID et laisse le chargeur en place au lieu de supprimer un widget encore actif lors des remontages en développement.
Vérifiez de nouveau le cycle de vie de Root, la sortie du plan de site et les origines de la CSP après une mise à niveau majeure de Docusaurus ou une modification du point de terminaison du widget.
| Point d'attention pour Docusaurus | Décision d'implémentation | Vérification |
|---|---|---|
| Root et navigation côté client | Créez le script asynchrone une seule fois à l'aide d'un ID stable. Ne renvoyez pas de fonction de nettoyage depuis l'effet, car Root et le widget doivent persister entre les routes. | Ouvrez deux liens internes de la documentation et vérifiez que document.querySelectorAll("#chattybox-widget").length vaut 1. |
| Politique de sécurité du contenu | Autorisez chattybox.ai dans script-src, l'origine de l'API configurée dans connect-src, fonts.googleapis.com dans style-src et fonts.gstatic.com dans font-src. Le widget actuel injectant son propre CSS de composant, un style-src strict nécessite également 'unsafe-inline' jusqu'à ce qu'une gestion par nonce ou une feuille de styles externe soit disponible. | Rechargez la page avec DevTools ouvert et vérifiez qu'aucune requête de script, de style, de police, fetch ou WebSocket n'est bloquée. |
| Versions, langues et périmètre du plan de site | Examinez le plan de site déployé avant l'exploration. N'incluez que les chemins des versions et langues prises en charge, ou utilisez des sources distinctes lorsque les publics ne doivent pas recevoir de réponses provenant d'autres versions. | Posez la même question propre à une version dans chaque langue indexée et vérifiez que chaque citation conserve le préfixe de route attendu. |
| Widget absent ou en double | Vérifiez la clé d'API, l'ID du chargeur, les messages de CSP dans la console, la réponse du script et si un autre composant du thème injecte également le widget. | Testez une version de production, et pas seulement le rechargement à chaud, puis examinez les panneaux Elements et Network après la navigation. |
Un test d'acceptation utile porte sur un paramètre dont la réponse peut varier selon la version, puis ouvre la citation afin de vérifier à la fois l'affirmation et l'URL versionnée.
Créez un composant racine de thème Docusaurus, ajoutez le script de widget une fois vos documents récupérés et déployez-le. Vos visiteurs peuvent ensuite poser des questions à partir de n'importe quelle page de documentation.
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}</>;
}Découvrez comment les réponses citées par la source fonctionnent sur les sites et plateformes de documentation technique.
Aidez les développeurs à résoudre plus rapidement les questions de configuration, de SDK, API et d'erreur de vos guides.
Comparez le même flux de travail cité par la source pour les sites MkDocs et Material for MkDocs.
Recherchez des guides de configuration pour VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo et d'autres plateformes de documentation.
Oui. ChattyBox peut explorer des pages publiques de documentation Docusaurus ou utiliser une URL de sitemap pour découvrir le contenu des docs.
Non. Vous intégrez ChattyBox avec une balise script, il fonctionne donc avec votre thème et votre déploiement Docusaurus existants.
Oui. Les réponses peuvent inclure des citations qui renvoient les utilisateurs vers les pages exactes de documentation utilisées pour la réponse.
Oui. Vous pouvez tester le contenu scrapé dans le tableau de bord avant de copier l’extrait du widget sur votre site Docusaurus.
Aucune carte de crédit requise. Votre contenu n’est pas utilisé pour l’entraînement de modèles.
Niveau Free. Aucune carte requise.