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 Docusaurus dla technical writerów, DevRel i zespołów wsparcia. ChattyBox przeszukuje dokumentację Docusaurus, odpowiada na pytania typu „Jak skonfigurować wersjonowanie?” na podstawie tych stron i cytuje wykorzystane źródło. Bez własnego RAG i bez migracji.
Niektóre narzędzia wsparcia AI wymagają rezerwacji wersji demonstracyjnej, zanim będziesz mógł przetestować produkt. ChattyBox jest samoobsługowy: dodaj swoją witrynę, przeszukaj dokumenty, przetestuj chatbota i osadź go, gdy będziesz gotowy.
ChattyBox przeszukuje istniejącą dokumentację, indeksuje treść w celu pobrania i osadza chatbota, który odpowiada, korzystając z dokumentów zamiast ogólnej pamięci modelu.
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 na jego skrypt i pochodzenie API w swojej Polityce bezpieczeństwa treści.
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, dane wyjściowe mapy witryny i pochodzenie CSP po ważnej aktualizacji Docusaurus lub zmianie punktu końcowego widżetu.
| Problem Docusaurus | Decyzja wdrożeniowa | Weryfikacja |
|---|---|---|
| Root i nawigacja po stronie klienta | Utwórz raz skrypt asynchroniczny według stabilnego identyfikatora. Nie zwracaj efektu czyszczenia, ponieważ Root i widżet mają trwać na różnych trasach. | Otwórz dwa wewnętrzne łącza do dokumentów i potwierdź, że document.querySelectorAll("#chattybox-widget").length ma wartość 1. |
| Polityka bezpieczeństwa treści | 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. | Przeładuj stronę przy otwartym DevTools i potwierdź brak zablokowanych żądań skryptów, stylów, czcionek, pobierania ani WebSocket. |
| Wersje, ustawienia regionalne i zakres mapy witryny | Przed zaindeksowaniem sprawdź wdrożoną mapę witryny. Uwzględnij tylko obsługiwane ścieżki wersji i ustawień regionalnych lub użyj oddzielnych źródeł, jeśli odbiorcy nie mogą otrzymywać odpowiedzi dotyczących różnych wersji. | Zadaj to samo pytanie specyficzne dla wydania w każdym indeksowanym języku i sprawdź, czy każdy cytat zachowuje oczekiwany przedrostek trasy. |
| Brakujący lub zduplikowany widżet | Sprawdź klucz API, identyfikator programu ładującego, komunikaty konsoli CSP, odpowiedź skryptu i czy inny komponent motywu również wstawia widżet. | Przetestuj wersję produkcyjną, a nie tylko przeładuj na gorąco, i sprawdź panele Elements i Network po nawigacji. |
Przydatny test akceptacyjny pyta o ustawienie, którego odpowiedź może różnić się w zależności od wydania, a następnie otwiera cytat w celu sprawdzenia zarówno twierdzenia, jak i wersji URL.
Utwórz komponent główny motywu Docusaurus, dodaj skrypt widżetu po pobraniu dokumentów i wdróż. Odwiedzający mogą następnie zadawać pytania na dowolnej stronie dokumentów.
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}</>;
}Zobacz, jak odpowiedzi oparte na źródłach działają w witrynach i platformach z dokumentacją techniczną.
Pomóż programistom szybciej rozwiązywać pytania dotyczące konfiguracji, SDK, API i błędów z Twoich przewodników.
Porównaj ten sam przepływ pracy z cytowanymi źródłami dla witryn MkDocs i Materiał dla witryn MkDocs.
Znajdź przewodniki konfiguracji dla platform VitePress, Starlight, Nextra, Mintlify, ReadMe, Hugo i innych platform z dokumentacją.
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.
Tak. Odpowiedzi mogą zawierać cytaty wskazujące użytkownikom dokładne strony dokumentacji użyte w odpowiedzi.
Tak. Możesz przetestować pobraną zawartość w panelu kontrolnym przed skopiowaniem fragmentu widżetu na swoją witrynę Docusaurus.
Karta kredytowa nie jest wymagana. Twoje treści nie są używane do trenowania modeli.
Plan Free. Bez karty.