Bisakah ChattyBox merayapi situs Docusaurus?
Ya. ChattyBox dapat merayapi halaman dokumentasi Docusaurus publik atau menggunakan URL peta situs untuk menemukan konten dokumen.
Chatbot AI Docusaurus untuk penulis teknis, DevRel, dan tim dukungan. ChattyBox merayapi dokumentasi Docusaurus Anda dan dapat menyertakan tautan ke halaman yang diambil dalam jawaban. Uji keakuratan jawaban dan kutipan. Tanpa RAG khusus dan tanpa migrasi.
Beberapa alat pendukung AI mengharuskan Anda memesan demo bahkan sebelum Anda dapat menguji produknya. ChattyBox bersifat mandiri: tambahkan situs Anda, jelajahi dokumen Anda, uji chatbot, dan sematkan saat Anda siap.
Alat pendukung AI tradisional
Pengaturan layanan mandiri
ChattyBox merayapi situs web, dokumentasi, pusat bantuan, CMS, atau basis pengetahuan yang sudah ada. Konten yang diambil dapat memandu jawaban chatbot; periksa keakuratan jawaban dan sitasinya.
Pilih sitemap Docusaurus produksi atau kumpulan jalur dokumentasi terkini, berversi, dan terlokalisasi yang ditentukan secara sengaja.
Lakukan crawling pada jalur yang dipilih, lalu uji pertanyaan terhadap rilis dan locale persis yang digunakan pengunjung Anda.
Instal satu loader persisten di src/theme/Root.tsx dan izinkan origin skrip serta API-nya dalam Content Security Policy Anda.
Navigasikan antarhalaman dokumentasi tanpa memuat ulang dan verifikasi satu instance widget, kutipan yang berfungsi, serta tidak adanya kesalahan konsol atau CSP.
Peluncuran tiga langkah
Docusaurus merender aplikasi React persisten saat terjadi perubahan jalur di sisi klien. Karena itu, wrapper Root yang diuji membuat satu loader, mengenali mount berikutnya berdasarkan ID, dan mempertahankan loader alih-alih menghapus widget yang masih aktif saat remount dalam pengembangan.
Periksa kembali siklus hidup Root, output sitemap, dan origin CSP setelah upgrade mayor Docusaurus atau perubahan endpoint widget.
| Aspek Docusaurus | Keputusan implementasi | Verifikasi |
|---|---|---|
Aspek Docusaurus Root dan navigasi klien | Keputusan implementasi Buat skrip async sekali berdasarkan ID stabil. Jangan kembalikan cleanup dari effect karena Root dan widget dimaksudkan untuk tetap ada di seluruh jalur. | Verifikasi Buka dua tautan dokumentasi internal dan pastikan document.querySelectorAll("#chattybox-widget").length bernilai 1. |
Aspek Docusaurus Kebijakan Keamanan Konten | Keputusan implementasi Izinkan chattybox.ai di script-src, origin API yang dikonfigurasi di connect-src, fonts.googleapis.com di style-src, dan fonts.gstatic.com di font-src. Widget saat ini menyisipkan CSS komponennya sendiri, sehingga style-src yang ketat juga memerlukan 'unsafe-inline' sampai build berbasis nonce atau stylesheet eksternal tersedia. | Verifikasi Muat ulang dengan DevTools terbuka dan pastikan tidak ada permintaan script, style, font, fetch, atau WebSocket yang diblokir. |
Aspek Docusaurus Versi, locale, dan cakupan sitemap | Keputusan implementasi Periksa sitemap yang telah di-deploy sebelum crawling. Sertakan hanya jalur rilis dan locale yang didukung. Untuk cakupan versi terpisah, gunakan proyek terpisah yang masing-masing hanya berisi halaman yang dimaksud, dan uji apakah ada jawaban lintas versi. | Verifikasi Ajukan pertanyaan khusus rilis yang sama di setiap locale terindeks dan periksa bahwa setiap kutipan mempertahankan prefiks jalur yang diharapkan. |
Aspek Docusaurus Widget hilang atau duplikat | Keputusan implementasi Periksa kunci API, ID loader, pesan konsol CSP, respons skrip, dan apakah komponen tema lain juga menyisipkan widget. | Verifikasi Uji build produksi, bukan hanya hot reload, dan periksa panel Elements serta Network setelah navigasi. |
Pengujian penerimaan yang berguna menanyakan pengaturan yang jawabannya dapat berbeda menurut rilis, lalu membuka kutipan untuk memverifikasi klaim dan URL berversi.
Daftar periksa praktis untuk mengevaluasi chatbot AI dokumentasiBuat komponen Root tema Docusaurus, tambahkan skrip widget setelah konten dokumentasi Anda diambil, lalu deploy. Pengunjung Anda kemudian dapat mengajukan pertanyaan dari halaman dokumentasi mana pun.
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}</>;
}Ya. ChattyBox dapat merayapi halaman dokumentasi Docusaurus publik atau menggunakan URL peta situs untuk menemukan konten dokumen.
Tidak. Anda menyematkan ChattyBox dengan tag skrip, sehingga dapat berfungsi bersamaan dengan tema dan penerapan Docusaurus yang ada.
Jawaban dapat menyertakan tautan ke halaman dokumentasi yang diambil, tetapi jawaban fallback mungkin tidak memiliki sumber. Periksa keakuratan jawaban dan kutipannya.
Ya. Anda dapat menguji konten yang diambil di dasbor sebelum menyalin cuplikan widget ke situs Docusaurus Anda.