Czy ChattyBox może przeszukać witrynę Docusaurus?
Tak. ChattyBox może przeszukiwać publiczne strony dokumentacji Docusaurus lub używać adresu URL mapy witryny do odkrywania treści dokumentów.
Chatbot AI dla dokumentacji Docusaurus, przeznaczony dla autorów dokumentacji technicznej, zespołów DevRel i wsparcia. ChattyBox przeszukuje dokumentację Docusaurus i może umieszczać w odpowiedziach linki do pobranych stron. Sprawdź poprawność odpowiedzi i cytatów. Bez własnego RAG i bez migracji.
Niektóre narzędzia wsparcia AI wymagają umówienia prezentacji, zanim będzie można przetestować produkt. ChattyBox jest samoobsługowy: dodaj witrynę, przeszukaj dokumentację, przetestuj chatbota i osadź go, gdy wszystko będzie gotowe.
Tradycyjne narzędzia wsparcia AI
Konfiguracja samoobsługowa
ChattyBox indeksuje istniejącą witrynę, dokumentację, centrum pomocy, CMS lub bazę wiedzy. Pobrane treści mogą pomagać chatbotowi w tworzeniu odpowiedzi; sprawdzaj poprawność odpowiedzi i cytowań.
Wybierz produkcyjną mapę witryny Docusaurus lub zamierzony zestaw bieżących, wersjonowanych i zlokalizowanych tras dokumentów.
Przeszukaj wybrane trasy, a następnie przetestuj pytania pod kątem dokładnej wersji i lokalizacji, z której korzystają odwiedzający.
Zainstaluj jeden trwały moduł ładujący w src/theme/Root.tsx i zezwól w Content Security Policy na źródła skryptu i API.
Nawiguj między stronami dokumentów bez ponownego ładowania i sprawdzaj jedną instancję widżetu, działające cytaty oraz brak błędów konsoli lub CSP.
Uruchomienie w trzech krokach
Docusaurus renderuje trwałą aplikację React wokół zmian tras po stronie klienta. Testowany wrapper Root tworzy zatem jeden moduł ładujący, rozpoznaje późniejsze montowania według identyfikatora i pozostawia moduł ładujący na miejscu, zamiast usuwać wciąż aktywny widżet podczas ponownego montowania w trybie programistycznym.
Sprawdź ponownie cykl życia Root, wygenerowaną mapę witryny i źródła dozwolone w CSP po aktualizacji Docusaurus do nowej wersji głównej lub zmianie punktu końcowego widżetu.
| Problem Docusaurus | Decyzja wdrożeniowa | Weryfikacja |
|---|---|---|
Problem Docusaurus Root i nawigacja po stronie klienta | Decyzja wdrożeniowa Utwórz skrypt asynchroniczny tylko raz, używając stałego identyfikatora. Nie zwracaj funkcji czyszczącej z efektu, ponieważ Root i widżet mają pozostawać aktywne podczas zmiany ścieżek. | Weryfikacja Otwórz dwa wewnętrzne łącza do dokumentów i potwierdź, że document.querySelectorAll("#chattybox-widget").length ma wartość 1. |
Problem Docusaurus Polityka bezpieczeństwa treści | Decyzja wdrożeniowa Zezwól na chattybox.ai w script-src, skonfigurowane pochodzenie API w connect-src, fonts.googleapis.com w style-src oraz fonts.gstatic.com w font-src. Obecny widżet wstrzykuje swój arkusz CSS komponentu, więc restrykcyjny style-src wymaga też 'unsafe-inline', dopóki nie będzie dostępna kompilacja obsługująca nonce lub zewnętrzny arkusz stylów. | Weryfikacja Przeładuj stronę przy otwartym DevTools i potwierdź brak zablokowanych żądań skryptów, stylów, czcionek, pobierania ani WebSocket. |
Problem Docusaurus Wersje, ustawienia regionalne i zakres mapy witryny | Decyzja wdrożeniowa Przed przeszukaniem sprawdź wdrożoną mapę witryny. Uwzględnij tylko ścieżki obsługiwanych wersji i języków. Aby oddzielić zakresy wersji, użyj osobnych projektów zawierających wyłącznie odpowiednie strony i sprawdź, czy odpowiedzi nie dotyczą innych wersji. | Weryfikacja Zadaj to samo pytanie specyficzne dla wydania w każdym indeksowanym języku i sprawdź, czy każdy cytat zachowuje oczekiwany przedrostek trasy. |
Problem Docusaurus Brakujący lub zduplikowany widżet | Decyzja wdrożeniowa Sprawdź klucz API, identyfikator programu ładującego, komunikaty konsoli CSP, odpowiedź skryptu i czy inny komponent motywu również wstawia widżet. | Weryfikacja Przetestuj kompilację produkcyjną, a nie tylko automatyczne przeładowywanie, i sprawdź panele Elements i Network po przejściu między stronami. |
W ramach testu akceptacyjnego zadaj pytanie o ustawienie, którego opis może różnić się zależnie od wydania, a następnie otwórz cytowane źródło, aby sprawdzić odpowiedź i wersjonowany adres URL.
Praktyczna lista kryteriów oceny chatbotów AI do dokumentacjiUtwórz komponent Root motywu Docusaurus, dodaj skrypt widżetu po pobraniu dokumentacji i wdróż witrynę. Odwiedzający mogą następnie zadawać pytania na dowolnej stronie dokumentacji.
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}</>;
}Tak. ChattyBox może przeszukiwać publiczne strony dokumentacji Docusaurus lub używać adresu URL mapy witryny do odkrywania treści dokumentów.
Nie. Osadzasz ChattyBox ze znacznikiem skryptu, aby działał on z istniejącym motywem i wdrożeniem Docusaurus.
Odpowiedzi mogą zawierać linki do pobranych stron dokumentacji, ale odpowiedzi zastępcze mogą nie zawierać źródeł. Sprawdź poprawność odpowiedzi i cytatów.
Tak. Możesz przetestować pobraną zawartość w panelu kontrolnym przed skopiowaniem fragmentu widżetu na swoją witrynę Docusaurus.