Voiko ChattyBox indeksoida Docusaurus-sivuston?
Kyllä. ChattyBox voi indeksoida julkisia Docusaurus dokumentaatiosivuja tai käyttää sivustokartan URL-osoitetta dokumenttien sisällön löytämiseen.
Docusaurus-tekoälychatbot teknisille kirjoittajille, DevRelille ja tukitiimeille. ChattyBox indeksoi Docusaurus-dokumentaatiosi ja voi lisätä vastauksiin linkkejä haetuille sivuille. Testaa vastausten ja lähdeviitteiden oikeellisuus. Ei omaa RAG-ratkaisua eikä siirtoa.
Jotkin tekoälypohjaiset tukityökalut edellyttävät demon varaamista jo ennen tuotteen testaamista. ChattyBox on itsepalvelutuote: lisää sivustosi, indeksoi dokumentaatiosi, testaa chatbotia ja upota se, kun olet valmis.
Perinteiset tekoälyn tukityökalut
Itsepalveluasennus
ChattyBox indeksoi nykyisen verkkosivustosi, dokumentaatiosi, ohjekeskuksesi, CMS:si tai tietämyskantasi. Haettu sisältö voi ohjata chatbotin vastauksia; tarkista vastausten ja lähdeviitteiden oikeellisuus.
Valitse Docusaurus-tuotantosivustokartta tai tarkoituksellinen joukko nykyisiä, versioituja ja lokalisoituja dokumenttireittejä.
Indeksoi valitut reitit ja testaa sitten kysymyksiä tarkan julkaisun ja vierailijoiden käyttämän kielen perusteella.
Asenna yksi pysyvä latausohjelma tiedostoon src/theme/Root.tsx ja salli sen komentosarjan ja API-alkuperät sisällön suojauskäytännössäsi.
Siirry dokumentaatiosivujen välillä lataamatta sivua uudelleen ja varmista, että widgetistä on vain yksi esiintymä, lähdeviitteet toimivat eikä konsolissa tai CSP:ssä näy virheitä.
Kolmivaiheinen käynnistys
Docusaurus renderöi pysyvän React-sovelluksen, joka säilyy asiakaspuolen reittimuutosten yli. Testattu Root-kääre luo siksi yhden latausskriptin, tunnistaa myöhemmät komponentin liittämiset tunnuksen perusteella ja jättää latausskriptin paikalleen sen sijaan, että poistaisi yhä aktiivisen widgetin kehitysaikaisten uudelleenliittämisten yhteydessä.
Tarkista Root-elinkaari, sivustokartan tulos ja CSP-alkuperät uudelleen Docusaurus-suuren päivityksen tai widgetin päätepisteen muutoksen jälkeen.
| Docusaurus huolenaihe | Täytäntöönpanopäätös | Vahvistus |
|---|---|---|
Docusaurus huolenaihe Root- ja asiakasnavigointi | Täytäntöönpanopäätös Luo asynkroninen skripti kerran pysyvän tunnisteen avulla. Älä palauta effectistä siivousfunktiota, koska Rootin ja widgetin on tarkoitus säilyä reittien välillä. | Vahvistus Avaa kaksi sisäistä dokumenttilinkkiä ja varmista, että document.querySelectorAll("#chattybox-widget").length on 1. |
Docusaurus huolenaihe Sisällön suojauskäytäntö | Täytäntöönpanopäätös Salli chattybox.ai script-src:ssä, määritetty API-alkuperä connect-src:ssä, fonts.googleapis.com style-src:ssä ja fonts.gstatic.com font-src:ssä. Nykyinen widget injektoi oman komponenttinsa CSS:n, joten tiukka style-src tarvitsee myös 'unsafe-inline'n, kunnes nonce-tietoinen tai ulkoinen tyylitiedostokoontiversio on saatavilla. | Vahvistus Lataa sivu uudelleen DevTools auki ja varmista, ettei estettyjä komentosarja-, tyyli-, fontti-, haku- tai WebSocket-pyyntöjä ole. |
Docusaurus huolenaihe Versiot, kieliversiot ja sivustokartan laajuus | Täytäntöönpanopäätös Tarkista julkaistu sivustokartta ennen indeksointia. Sisällytä vain tuettujen julkaisujen ja kieliversioiden polut. Erota versiot käyttämällä erillisiä projekteja, joissa kussakin on vain kyseiseen versioon tarkoitetut sivut, ja testaa, sekoittuvatko versiot vastauksissa. | Vahvistus Esitä sama julkaisukohtainen kysymys jokaisella indeksoidulla kielellä ja tarkista, että jokainen lähdeviite säilyttää odotetun reittietuliitteen. |
Docusaurus huolenaihe Widget puuttuu tai näkyy kahdesti | Täytäntöönpanopäätös Tarkista API-avain, lataustunnus, CSP-konsolin viestit, komentosarjan vastaus ja lisääkö jokin muu teemakomponentti myös widgetin. | Vahvistus Testaa tuotantoversiota, ei vain kuumaa uudelleenlatausta, ja tarkasta Elements- ja Network-paneelit navigoinnin jälkeen. |
Hyödyllisessä hyväksymistestissä kysytään asetuksesta, jonka vastaus voi vaihdella julkaisuittain, ja avataan sitten lähdeviite sekä väitteen että versioidun URL-osoitteen tarkistamiseksi.
Käytännön tarkistuslista dokumentaation AI-chatbottien arviointiinLuo Docusaurus-teeman Root-komponentti, lisää widget-skripti dokumentaation haun jälkeen ja julkaise sivusto. Kävijät voivat sitten esittää kysymyksiä miltä tahansa dokumentaatiosivulta.
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}</>;
}Kyllä. ChattyBox voi indeksoida julkisia Docusaurus dokumentaatiosivuja tai käyttää sivustokartan URL-osoitetta dokumenttien sisällön löytämiseen.
Ei. Upota ChattyBox komentosarjatunnisteella, joten se toimii olemassa olevan Docusaurus-teeman ja käyttöönoton rinnalla.
Vastaukset voivat sisältää linkkejä haetuille dokumentaatiosivuille, mutta varavastauksissa ei välttämättä ole lähteitä. Tarkista vastausten ja lähdeviitteiden oikeellisuus.
Kyllä. Voit testata haettua sisältöä hallintapaneelissa ennen kuin kopioit widget-koodinpätkän Docusaurus-sivustollesi.