Kas ChattyBox saab Docusaurus saidil roomata?
Jah. ChattyBox saab dokumentide sisu leidmiseks roomata avalikel Docusaurus dokumentatsioonilehtedel või kasutada saidiplaani URL-i.
Docusauruse tehisintellekti vestlusrobot tehnilistele kirjutajatele, DevRel- ja tugimeeskondadele. ChattyBox roomab teie Docusauruse dokumente, vastab küsimustele nagu „Kuidas versioonimist seadistada?“ nendelt lehtedelt ja viitab kasutatud allikale. Kohandatud RAG-ta ja migreerimiseta.
Mõned tehisintellekti tugitööriistad panevad broneerima demo enne, kui saate toodet isegi testida. ChattyBox on iseteeninduslik: lisage oma sait, roomake oma dokumentides, testige vestlusbotit ja manustage see, kui olete valmis.
ChattyBox roomab teie olemasolevas dokumentatsioonis, indekseerib allalaadimiseks sisu ja manustab vestlusroti, mis vastab teie dokumentidele, mitte üldise mudelimälule.
Valige tootmiskeskkonna Docusauruse saidikaart või sihipärane praeguste, versioonitud ja lokaliseeritud dokumentatsiooniteede kogum.
Indekseerige valitud teed ja testige seejärel küsimusi täpselt selle väljalaske ning lokaadi suhtes, mida külastajad kasutavad.
Paigaldage üks püsiv laadur faili src/theme/Root.tsx ning lubage selle skripti ja API päritolud oma Content Security Policy reeglites.
Liikuge dokumentatsioonilehtede vahel ilma uuesti laadimata ning kontrollige, et olemas oleks üks vidina eksemplar, viited töötaksid ja konsooli- ega CSP-vigu poleks.
Kolmeastmeline käivitamine
Docusaurus renderdab kliendipoolsete teemuudatuste ümber püsiva Reacti rakenduse. Seetõttu loob testitud Root ümbris ühe laaduri, tuvastab hilisemad haakimised ID järgi ja jätab laaduri paigale, selle asemel et arendusaegse taasühendamise ajal endiselt aktiivne vidin eemaldada.
Kontrollige Root elutsüklit, saidikaardi väljundit ja CSP päritolusid uuesti pärast Docusauruse põhiversiooni uuendust või vidina lõpp-punkti muutmist.
| Docusauruse küsimus | Teostusotsus | Kontrollimine |
|---|---|---|
| Root ja kliendipoolne navigeerimine | Looge asünkroonne skript püsiva ID järgi üks kord. Ärge tagastage efektist puhastust, sest Root ja vidin peavad teede vahel püsima. | Avage kaks sisemist dokumentatsioonilinki ja veenduge, et document.querySelectorAll("#chattybox-widget").length on 1. |
| Sisuturbepoliitika | Lubage chattybox.ai direktiivis script-src, seadistatud API päritolu direktiivis connect-src, fonts.googleapis.com direktiivis style-src ja fonts.gstatic.com direktiivis font-src. Praegune vidin sisestab oma komponendi CSS-i, seega vajab range style-src ka 'unsafe-inline'-i, kuni on saadaval nonce-tuge pakkuv või väline laaditabel. | Laadige leht avatud DevToolsiga uuesti ja veenduge, et blokeeritud skripti-, stiili-, font-, fetch- ega WebSocket-päringuid poleks. |
| Versioonide, lokaatide ja saidikaardi ulatus | Kontrollige juurutatud saidikaarti enne indekseerimist. Kaasake ainult toetatud väljalaske- ja lokaaditeed või kasutage eraldi allikaid, kui sihtrühmad ei tohi saada versioonideüleseid vastuseid. | Esitage igas indekseeritud lokaadis sama väljalaskepõhine küsimus ja kontrollige, et iga viide säilitaks oodatud teeprefiksi. |
| Puuduv või dubleeritud vidin | Kontrollige API-võtit, laaduri ID-d, CSP konsooliteateid, skripti vastust ja seda, kas mõni teine teemakomponent lisab samuti vidina. | Testige tootmisjärku, mitte ainult kuumlaadimist, ning kontrollige pärast navigeerimist paneele Elements ja Network. |
Kasulik vastuvõtutest küsib seadistuse kohta, mille vastus võib väljalaske järgi erineda, ning avab seejärel viite, et kontrollida nii väidet kui ka versioonitud URL-i.
Looge Docusauruse teema juurkomponent, lisage pärast dokumentide kraapimist vidina skript ja juurutage. Teie külastajad saavad seejärel esitada küsimusi mis tahes dokumentide lehel.
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}</>;
}Vaadake, kuidas allikale viidatud vastused tehnilise dokumentatsiooni saitidel ja platvormidel töötavad.
Aidake arendajatel lahendada teie juhendite seadistus-, SDK-, API- ja veaküsimused kiiremini.
Võrrelge sama allikale viidatud töövoogu MkDocsi ja MkDocsi saitide materjali jaoks.
Otsige häälestusjuhendeid VitePressi, Starlighti, Nextra, Mintlify, ReadMe, Hugo ja muude dokumentide platvormide jaoks.
Jah. ChattyBox saab dokumentide sisu leidmiseks roomata avalikel Docusaurus dokumentatsioonilehtedel või kasutada saidiplaani URL-i.
Ei. Manustate ChattyBox skriptimärgendiga, nii et see töötab koos teie olemasoleva Docusaurus teema ja juurutusega.
Jah. Vastused võivad sisaldada tsitaate, mis suunavad kasutajad tagasi vastuseks kasutatud täpsetele dokumentatsioonilehtedele.
Jah. Enne vidina koodilõigu kopeerimist oma saidile Docusaurus saate armatuurlaual kogutud sisu testida.
Krediitkaarti pole vaja. Teie sisu ei kasutata mudelite treenimiseks.
Tasuta pakett. Kaarti pole vaja.