Může ChattyBox procházet web Docusaurus?
Ano. ChattyBox může procházet veřejné stránky dokumentace Docusaurus nebo používat adresu URL souboru Sitemap k objevování obsahu dokumentů.
AI chatbot Docusaurus pro technické autory, DevRel a týmy podpory. ChattyBox prochází vaši dokumentaci Docusaurus, odpovídá na otázky jako „Jak nakonfiguruji verzování?“ přímo z těchto stránek a cituje zdroj, který použil. Žádné vlastní RAG a žádná migrace.
Některé podpůrné nástroje AI vás nutí zarezervovat si demo ještě předtím, než budete moci produkt otestovat. ChattyBox je samoobslužný: přidejte svůj web, procházejte své dokumenty, otestujte chatbota a vložte jej, až budete připraveni.
ChattyBox prochází vaši stávající dokumentaci, indexuje obsah pro vyhledání a vkládá chatbota, který odpovídá pomocí vašich dokumentů namísto obecné paměti modelu.
Vyberte produkční mapu webu Docusaurus nebo záměrnou sadu aktuálních, verzovaných a lokalizovaných tras dokumentů.
Projděte vybrané trasy a poté otestujte otázky pro přesnou verzi a jazyk, které vaši návštěvníci používají.
Nainstalujte jeden trvalý zavaděč do src/theme/Root.tsx a povolte původ jeho skriptu a API v zásadách zabezpečení obsahu.
Procházejte mezi stránkami dokumentů bez opětovného načítání a ověřte jednu instanci widgetu, fungující citace a žádné chyby konzole nebo CSP.
Spuštění ve třech krocích
Docusaurus při změnách tras na straně klienta zachovává aplikaci React. Otestovaný obal Root proto vytvoří jediný zavaděč, pozdější připojení rozpozná podle ID a ponechá zavaděč na místě, aby při opakovaném připojení ve vývoji neodstranil stále aktivní widget.
Po zásadním upgradu Docusaurus nebo změně koncového bodu widgetu znovu zkontrolujte životní cyklus Root, výstup mapy webu a původ CSP.
| Oblast Docusaurus | Prováděcí rozhodnutí | Ověření |
|---|---|---|
| Root a klientská navigace | Vytvořte asynchronní skript jednou pomocí stabilního ID. Nevracejte vyčištění z efektu, protože Root a widget mají přetrvávat napříč trasami. | Otevřete dva interní odkazy na dokumenty a potvrďte, že document.querySelectorAll("#chattybox-widget").length je 1. |
| Zásady zabezpečení obsahu | Povolte chattybox.ai v script-src, nakonfigurovaný původ API v connect-src, fonts.googleapis.com ve style-src a fonts.gstatic.com ve font-src. Současný widget vkládá vlastní CSS komponenty, takže přísné style-src vyžaduje také 'unsafe-inline', dokud nebude k dispozici varianta s nonce nebo externím stylem. | Načtěte stránku znovu s otevřeným DevTools a potvrďte, že nejsou blokovány žádné požadavky na skript, styl, font, načítání dat ani WebSocket. |
| Verze, národní prostředí a rozsah souboru Sitemap | Před procházením zkontrolujte nasazenou mapu webu. Zahrňte pouze podporované cesty k vydání a národnímu prostředí nebo použijte samostatné zdroje, pokud publikum nesmí dostávat odpovědi napříč verzemi. | Položte stejnou otázku specifickou pro vydání v každém indexovaném národním prostředí a zkontrolujte, zda každá citace zachovává očekávanou předponu trasy. |
| Chybějící nebo duplicitní widget | Zkontrolujte klíč API, ID zavaděče, zprávy konzoly CSP, odezvu skriptu a zda další komponenta motivu také vkládá widget. | Otestujte produkční sestavení, nejen opětovné načítání za běhu, a po navigaci zkontrolujte panely Elements a Network. |
Užitečný akceptační test se ptá na nastavení, jehož hodnota se může lišit podle vydání, a poté otevře citaci a ověří tvrzení i adresu URL dané verze.
Vytvořte kořenovou komponentu motivu Docusaurus, přidejte skript widgetu poté, co jsou vaše dokumenty seškrábány, a nasaďte. Vaši návštěvníci pak mohou klást otázky z libovolné stránky dokumentů.
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}</>;
}Podívejte se, jak fungují odpovědi citované zdrojem na webech a platformách technické dokumentace.
Pomozte vývojářům rychleji vyřešit otázky týkající se nastavení, sady SDK, API a chyb z vašich průvodců.
Porovnejte stejný pracovní postup s uvedením zdroje pro weby MkDocs a Material for MkDocs.
Najděte průvodce nastavením pro platformy VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo a další.
Ano. ChattyBox může procházet veřejné stránky dokumentace Docusaurus nebo používat adresu URL souboru Sitemap k objevování obsahu dokumentů.
Ne. ChattyBox vložíte pomocí značky skriptu, takže funguje společně s vaším stávajícím motivem a nasazením Docusaurus.
Ano. Odpovědi mohou obsahovat citace, které uživatele nasměrují zpět na přesné stránky dokumentace použité pro odpověď.
Ano. Před zkopírováním úryvku widgetu na svůj web Docusaurus můžete otestovat zkopírovaný obsah na řídicím panelu.
Není vyžadována kreditní karta. Váš obsah se nepoužívá k trénování modelů.
Tarif Free. Bez karty.