Przejdź do głównej treści
Wsparcie dla dokumentacji Docusaurus

Dodaj chatbota AI z cytowanymi źródłami do swojej dokumentacji Docusaurus

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.

Indeksuje opublikowane strony dokumentacjiOdpowiedzi z cytowaniami źródełOsadzenie jednym skryptemBez migracji dokumentacjiKarta kredytowa nie jest wymaganaTwoje treści pozostają Twoje
Zapytaj ChattyBox
Od czego zacząć, jeśli potrzebuję wiarygodnej odpowiedzi z tej strony?
Zacznij od dodania adresu publicznej witryny do ChattyBox. Wyszukuje zindeksowane treści, aby ukierunkować odpowiedzi, i może pokazywać odnośniki do stron źródłowych do sprawdzenia przez odwiedzających. Przetestuj odpowiedzi i zachowanie awaryjne przed uruchomieniem.
iŹródła3^
Docusaurus przewodnik
chattybox.ai
Analityka
chattybox.ai
Strona główna
chattybox.ai

Przykładowa rozmowa — to nie jest czat na żywo.

Obsługiwane przez ChattyBox
Konfiguracja samoobsługowa

Nie jest wymagana żadna rozmowa sprzedażowa

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

  • Zarezerwuj demonstrację
  • Ceny ukryte lub zależne od sprzedaży
  • Skoncentrowany na przedsiębiorstwach
  • Najpierw rozmowa sprzedażowa

Konfiguracja samoobsługowa

ChattyBox

  • Zacznij od razu
  • Ceny publiczne
  • Stworzony dla witryn z dokumentami, małych zespołów, OSS i SaaS
  • Najpierw przetestuj to sam

Uruchom chatbota z cytowaniami źródeł bez przebudowy stosu witryny

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ń.

Opakowanie Root Docusaurus 3 ładuje widżet raz na cały okres istnienia aplikacji klienckiej.
Zakres indeksowania może podążać za bieżącymi, wersjonowanymi, zlokalizowanymi lub celowo filtrowanymi ścieżkami dokumentacji.
Cytaty mogą odsyłać czytelników do pobranych stron Docusaurus. Sprawdź odpowiedź oraz ścieżkę wersji i języka.
Powtarzalny przykład obejmuje zapobieganie duplikatom, nawigację klienta, CSP i weryfikację na poziomie trasy.
Krok przepływu pracy

Wybierz produkcyjną mapę witryny Docusaurus lub zamierzony zestaw bieżących, wersjonowanych i zlokalizowanych tras dokumentów.

Krok przepływu pracy

Przeszukaj wybrane trasy, a następnie przetestuj pytania pod kątem dokładnej wersji i lokalizacji, z której korzystają odwiedzający.

Krok przepływu pracy

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.

Krok przepływu pracy

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

Wklej swój adres URL Docusaurus, przetestuj cytowane odpowiedzi, a następnie zainstaluj widżet.

Sprawdzone dowody redakcyjne

Przetestowana integracja Docusaurus 3, a nie skrypt na poziomie trasy

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.

Autor techniczny
Zespół dokumentacji ChattyBox
Recenzent techniczny
Inżynieria ChattyBox
Ostatnia aktualizacja
Informacje sprawdzone
Docusaurus 3.10 i aktualny widżet ChattyBox

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.

Docusaurus Komponent główny zapobiegający duplikowaniu skryptu ChattyBox po nawigacji klienta
Oryginalne odniesienie do instalacji: moduł ładujący ma stabilny identyfikator, ładuje asynchronicznie i pozostaje obecny, gdy Docusaurus zmienia trasy.
Docusaurus 3 decyzje dotyczące instalacji i ich kompleksowe kontrole.
Problem DocusaurusDecyzja wdrożeniowaWeryfikacja
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.
Sprawdzanie cytowanych odpowiedzi

Przetestuj odpowiedź tam, gdzie liczy się ścieżka wydania

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 dokumentacji
Zapytaj dokumentację Docusaurus
Jak ustawić domyślne otwieranie najnowszych stabilnych dokumentów?
W konfiguracji wtyczki dokumentacji ustaw lastVersion na wersję, która ma się otwierać odwiedzającym, i użyj onlyIncludeVersions, gdy chcesz ograniczyć publikowane wydania. Zachowaj ścieżkę bieżącej dokumentacji tylko wtedy, gdy chcesz udostępnić użytkownikom dokumentację dotyczącą jeszcze niewydanej wersji.

Przykładowa rozmowa — to nie jest czat na żywo.

Obsługiwane przez ChattyBox
Odpowiedź ChattyBox na temat domyślnej wersji Docusaurus z cytatem z przewodnika po wersji
Oryginalne odniesienie do wyniku: odpowiedź zawiera nazwę odpowiednich ustawień wersji i jako dowód przedstawia oficjalny przewodnik po wersji.
Ścieżka instalacji

Jak dodać ChattyBox do Docusaurus

Utwó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.

  1. 1Utwórz projekt ChattyBox i wprowadź adres URL lub mapę witryny dokumentów Docusaurus.
  2. 2Przetestuj prawdziwe pytania Docusaurus w panelu kontrolnym i potwierdź, że cytaty prowadzą do właściwych stron.
  3. 3Dodaj skrypt widgetu w src/theme/Root.tsx, aby ładował się w witrynie dokumentacji.
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}</>;
}
Najczęstsze pytania

Często zadawane pytania

1

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.

2

Czy muszę zmienić motyw Docusaurus?

Nie. Osadzasz ChattyBox ze znacznikiem skryptu, aby działał on z istniejącym motywem i wdrożeniem Docusaurus.

3

Czy odpowiedzi będą prowadzić do stron Docusaurus?

Odpowiedzi mogą zawierać linki do pobranych stron dokumentacji, ale odpowiedzi zastępcze mogą nie zawierać źródeł. Sprawdź poprawność odpowiedzi i cytatów.

4

Czy mogę przetestować bota przed jego instalacją?

Tak. Możesz przetestować pobraną zawartość w panelu kontrolnym przed skopiowaniem fragmentu widżetu na swoją witrynę Docusaurus.