Siirry pääsisältöön
Docusaurus Docs-tuki

Lisää lähdeviitteillä varustettu AI-chatbot Docusaurus-dokumentaatioosi

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.

Indeksoi julkaistut asiakirjasivutLähdeviitteelliset vastauksetUpota yhdellä skriptilläAsiakirjojen siirtoa ei vaaditaLuottokorttia ei vaaditaSisältösi pysyy sinun
Kysy ChattyBoxilta
Mistä minun kannattaa aloittaa, jos tarvitsen luotettavan vastauksen tältä sivustolta?
Aloita lisäämällä julkisen sivustosi URL ChattyBoxiin. Se hakee indeksoitua sisältöä vastausten tueksi ja voi näyttää lähdesivulinkkejä kävijöiden tarkistettavaksi. Testaa vastaukset ja varavastaukset ennen julkaisua.
iLähteet3^
Docusaurus opas
chattybox.ai
Analytiikka
chattybox.ai
Etusivu
chattybox.ai

Havainnollistava keskustelu — ei live-chat.

Palvelun tarjoaa ChattyBox
Itsepalveluasennus

Myyntisoittoa ei tarvita

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

  • Varaa demo
  • Hinnoittelu piilotettu tai myyntilähtöinen
  • Yrityskeskeinen
  • Myyntikeskustelu ensin

Itsepalveluasennus

ChattyBox

  • Aloita heti
  • Julkinen hinnoittelu
  • Suunniteltu dokumenttisivustoille, pienille ryhmille, OSS:lle ja SaaS:lle
  • Testaa ensin itse

Lanseeraa lähdeviitteillä varustettu chatbot rakentamatta sivustosi pinoa uudelleen

ChattyBox indeksoi nykyisen verkkosivustosi, dokumentaatiosi, ohjekeskuksesi, CMS:si tai tietämyskantasi. Haettu sisältö voi ohjata chatbotin vastauksia; tarkista vastausten ja lähdeviitteiden oikeellisuus.

Docusaurus 3 -juurikääre lataa widgetin kerran asiakassovelluksen käyttöiän ajan.
Indeksoinnin laajuus voi seurata nykyisiä, versioituja, lokalisoituja tai tarkoituksella suodatettuja dokumentaatioreittejä.
Lähdeviitteet voivat ohjata lukijat haetuille Docusaurus-sivuille. Tarkista vastaus sekä version ja kieliversion polku.
Toistettavissa oleva esimerkki kattaa päällekkäisyyksien eston, asiakasnavigoinnin, CSP:n ja reittitason vahvistuksen.
Työnkulun vaihe

Valitse Docusaurus-tuotantosivustokartta tai tarkoituksellinen joukko nykyisiä, versioituja ja lokalisoituja dokumenttireittejä.

Työnkulun vaihe

Indeksoi valitut reitit ja testaa sitten kysymyksiä tarkan julkaisun ja vierailijoiden käyttämän kielen perusteella.

Työnkulun vaihe

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.

Työnkulun vaihe

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

Liitä Docusaurus-URL-osoite, testaa lähdeviitteelliset vastaukset ja asenna sitten widget.

Testattu toimituksellinen näyttö

Testattu Docusaurus 3 -integraatio, ei reittitason komentosarja

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

Tekninen kirjoittaja
ChattyBox-dokumentaatioryhmä
Tekninen arvioija
ChattyBoxin tekninen tiimi
Viimeksi päivitetty
Tiedot tarkistettu
Docusaurus 3.10 ja nykyinen ChattyBox-widget

Tarkista Root-elinkaari, sivustokartan tulos ja CSP-alkuperät uudelleen Docusaurus-suuren päivityksen tai widgetin päätepisteen muutoksen jälkeen.

Docusauruksen Root-komponentti, joka estää ChattyBox-skriptin kaksoiskappaleen asiakaspuolen navigoinnin jälkeen
Alkuperäinen asennusviite: lataajalla on vakaa tunniste, se latautuu asynkronisesti ja pysyy paikallaan, kun Docusaurus vaihtaa reittiä.
Docusaurus 3 asennuspäätökset ja niiden päästä päähän -tarkistukset.
Docusaurus huolenaiheTäytäntöönpanopäätösVahvistus
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.
Siteerattujen vastausten tarkistus

Testaa vastausta, jos julkaisupolulla on merkitystä

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 arviointiin
Kysy Docusaurus-asiakirjoista
Kuinka saan uusimmat vakaat asiakirjat auki oletusarvoisesti?
Aseta dokumentaatiolaajennuksen määrityksissä lastVersion arvoksi versio, jonka haluat avautuvan vierailijoille, ja rajoita julkaistavia versioita tarvittaessa onlyIncludeVersions-asetuksella. Säilytä nykyisen dokumentaation reitti vain, jos haluat käyttäjien pääsevän julkaisemattomaan dokumentaatioon.

Havainnollistava keskustelu — ei live-chat.

Palvelun tarjoaa ChattyBox
ChattyBox-vastaus Docusauruksen oletusversiosta ja viittaus versiointioppaaseen
Alkuperäinen tulosviite: vastaus nimeää asiaankuuluvat versioasetukset ja esittää virallisen versiointioppaan todisteena.
Asennuspolku

Kuinka lisätä ChattyBox Docusaurukseen

Luo Docusaurus-teeman Root-komponentti, lisää widget-skripti dokumentaation haun jälkeen ja julkaise sivusto. Kävijät voivat sitten esittää kysymyksiä miltä tahansa dokumentaatiosivulta.

  1. 1Luo ChattyBox-projekti ja kirjoita Docusaurus-dokumenttien URL-osoite tai sivustokartta.
  2. 2Testaa todellisia Docusaurus-kysymyksiä hallintapaneelissa ja varmista, että lähdeviitteet osoittavat oikeille sivuille.
  3. 3Lisää widget-skripti tiedostoon src/theme/Root.tsx, jotta se latautuu koko dokumentaatiosivustollasi.
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}</>;
}
UKK

Yleisiä kysymyksiä

1

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.

2

Pitääkö minun vaihtaa Docusaurus teemani?

Ei. Upota ChattyBox komentosarjatunnisteella, joten se toimii olemassa olevan Docusaurus-teeman ja käyttöönoton rinnalla.

3

Linkitetäänkö vastaukset Docusaurus -sivuille?

Vastaukset voivat sisältää linkkejä haetuille dokumentaatiosivuille, mutta varavastauksissa ei välttämättä ole lähteitä. Tarkista vastausten ja lähdeviitteiden oikeellisuus.

4

Voinko testata bottia ennen sen asentamista?

Kyllä. Voit testata haettua sisältöä hallintapaneelissa ennen kuin kopioit widget-koodinpätkän Docusaurus-sivustollesi.