Siirry pääsisältöön
MkDocs Tukibotti

Lisää lähdeviitteillä varustettu AI-chatbot MkDocs- ja Material-dokumentaatioosi

Tekoälychatbot MkDocs- ja Material for MkDocs -dokumentaatioon. ChattyBox indeksoi julkisen sivustosi ja voi lisätä vastauksiin linkkejä haetuille sivuille. Testaa vastausten ja lähdeviitteiden oikeellisuus. Ei Python-indeksointiputkea tai omaa RAG-ratkaisua ylläpidettäväksi.

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^
MkDocs opas
chattybox.ai
Analytiikka
chattybox.ai
Etusivu
chattybox.ai

Havainnollistava keskustelu — ei live-chat.

Palvelun tarjoaa ChattyBox

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.

Material-ohitus säilyttää teeman JavaScript ja lisää yhden asynkronisen widget-lataajan.
Vanilla MkDocs käyttää erillistä mukautettua teemahakemistoa Material-polkujen oletuksen sijaan.
Tarkistukset kattavat haun yhteensopivuuden, välittömän navigoinnin, päällekkäiset latausskriptit ja kapeat mobiilinäkymät.
Versiotietoinen indeksointivalinta pitää vakaat, uusimmat ja vanhat mike-reitit tarkoituksellisena.
Työnkulun vaihe

Indeksoi käyttöön otettu MkDocs-sivustokartta tai vakaat ja versioidut polut, joita tuet tarkoituksella.

Työnkulun vaihe

Testaa tuotetta, Pythonia ja APIa koskevia kysymyksiä ja avaa jokainen lähdeviite ennen asennusta.

Työnkulun vaihe

Määritä Materialissa theme.custom_dir ja laajenna base.html-mallia tiedostosta overrides/main.html säilyttäen scripts-lohko super()-kutsulla.

Työnkulun vaihe

Tarkista sisäänrakennettu haku, välitön navigointi, mobiiliohjaimet, CSP ja jokainen julkaistu mike-versio.

Kolmivaiheinen käynnistys

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

MkDocs-kohtainen työnkulku

Keskustelutuki staattisille Python-dokumentaatiosivustoille

MkDocs-tiimit haluavat yleensä nopeita staattisia rakennelmia, selkeää navigointia ja luettavaa teknistä sisältöä. ChattyBox pitää työnkulun ennallaan ja lisää lähteeseen viitatun avustajan julkaistun sivuston päälle.

Päätöksen polku

Käytä näitä tarkistuspisteitä päättääksesi, pitäisikö ChattyBoxin toimia dokumentaatioalustasi rinnalla, korvata erillinen avustaja vai pysyä erillään testausta varten.

01

Toimii Material for MkDocs -sivujen kanssa

Indeksoi oppaat, viitesivut ja luotu staattinen HTML julkisilta MkDocs- tai Material for MkDocs -sivustoilta vaihtamatta teemaasi.

02

Käsittele versioitua dokumentaatiota tarkoituksella

Ohjaa ChattyBox niihin versiopolkuihin, joista haluat käyttäjien kysyvän, ja testaa sitten, viittaavatko vastaukset haluttuun vakaaseen, uusimpaan tai vanhaan dokumentaatioon.

03

Python-indeksointityötä ei ylläpidetä

Koska ChattyBox indeksoi julkisen sivuston, tiimien ei tarvitse lisätä vektori-indeksointia MkDocs-koontiputkeensa tai CI-skripteihinsä.

04

Paranna asiakirjoja oikeista kysymyksistä

Tarkastele Pro- tai Business-paketissa merkittyjä kysymyksiä heuristisina merkkeinä mahdollisesti puuttuvista esimerkeistä, epäselvistä asennusvaiheista tai vanhentuneista vianetsintäsivuista.

Testattu toimituksellinen näyttö

Testatut Material for MkDocs- ja MkDocs-asennuspolut

Material for MkDocs ja MkDocsin sisäänrakennettu teema tukevat mallipohjien periytymistä, mutta niille pitää käyttää erillisiä mukautettuja hakemistoja. Alla oleva Material-polku säilyttää scripts-lohkon super()-kutsulla, lisää yhden asynkronisen lataajan ja kestää välittömän navigoinnin muuttamatta hakutoimintoa.

Tekninen kirjoittaja
ChattyBox-dokumentaatioryhmä
Tekninen arvioija
ChattyBoxin tekninen tiimi
Viimeksi päivitetty
Tiedot tarkistettu
MkDocs, Material for MkDocs ja mike

Tarkista mallien lohkot ja välittömän navigoinnin toiminta teemapäivitysten jälkeen ja indeksoi uudelleen aina, kun mike-alias liikkuu.

Material for MkDocs -teeman custom_dir-määritys ja teeman skriptit säilyttävä päämallipohjan korvaus
Alkuperäinen asennusviite: theme.custom_dir valitsee ohituksen ja super() pitää Material-haku- ja navigointikomentosarjat ennallaan.
Material for MkDocs- ja MkDocs-asennusten päätökset päästä päähän ulottuvine tarkistuksineen.
MkDocs huolenaiheTäytäntöönpanopäätösVahvistus
MkDocs huolenaihe
Material ohitus
Täytäntöönpanopäätös
Aseta theme.name arvoksi material ja theme.custom_dir arvoksi overrides. Laajenna base.html-mallipohjaa, korvaa scripts-lohko, kutsu super() ja lisää sitten widget-skripti.
Vahvistus
Rakenna ja palvele sivusto ja vahvista sitten, että Material-haku ja navigointi toimivat edelleen.
MkDocs huolenaihe
Vanilja MkDocs
Täytäntöönpanopäätös
Käytä asetusta theme.name: mkdocs ja erillistä custom_theme-hakemistoa. Lisää vastaava custom_theme/main.html-ohitus Material-mallien kopioimisen sijaan.
Vahvistus
Suorita mkdocs serve ja tarkista haku, seuraavan ja edellisen sivun linkit sekä widget useammalla kuin yhdellä sivulla.
MkDocs huolenaihe
Asynkroninen lataus ja kopiot
Täytäntöönpanopäätös
Säilytä yksi latausohjelma perittyjen komentosarjojen lohkossa, anna sille vakaa tunnus, äläkä lisää samaa katkelmaa extra_javascript:n tai muun osan kautta.
Vahvistus
Varmista täysien sivulatausten ja Materialin välittömien siirtymien jälkeen, että document.querySelectorAll("#chattybox-widget").length on 1.
MkDocs 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
Tarkista selainkonsolista ja Network-paneelista estettyjen komentosarja-, tyyli-, fontti-, haku- tai WebSocket-pyyntöjen varalta.
MkDocs huolenaihe
Haku, välitön navigointi ja mobiili
Täytäntöönpanopäätös
Säilytä teemaskriptit super():lla ja pidä käynnistysohjelma poissa hakuikkunasta, vetolaatikosta, sivutus- ja suostumussäätimistä.
Vahvistus
Testaa näppäimistöllä käytettävää hakua, useita välittömän navigoinnin linkkejä ja 390 pikselin näkymää ilman päällekkäisyyttä tai vaakasuuntaista vieritystä.
MkDocs huolenaihe
mike versiot
Täytäntöönpanopäätös
Valitse vakaat, uusimmat tai erikseen määritetyt versiopolut tietoisesti. Indeksoi uudelleen aliaksen siirtämisen jälkeen ja sulje pois julkaisut, joita ei tueta, jos versioiden tietoja sekoittavat vastaukset johtaisivat käyttäjiä harhaan.
Vahvistus
Testaa versionvaihtoa komennolla mike serve ja varmista, että lähdeviitteet avautuvat halutun version sisällä.
MkDocs huolenaihe
Widget tai lainausvirhe
Täytäntöönpanopäätös
Tarkista YAML-sisennys, aktiivinen custom_dir, peritty lohkon nimi, API-avain, CSP, sivustokartan sisältö ja sisältääkö käyttöön otettu koontiversio ohituksen.
Vahvistus
Tarkista luotu HTML ja testaa tuotantoartefaktia sen sijaan, että luottaisit vain reaaliaikaiseen uudelleenlataukseen.
Siteerattujen vastausten tarkistus

Testaa vastausta aktiiviseen versioon

Esitä teemaa koskeva kysymys, johon liittyy tarkistettavissa oleva mallipohjan sääntö. Avaa sitten lähdeviite ja varmista, että se vastaa vierailijan valitsemaa versiota.

Käytännön tarkistuslista dokumentaation AI-chatbottien arviointiin
Kysy MkDocs-oppaista
Kuinka lisään widgetin rikkomatta Material-hakua?
Aseta theme.custom_dir arvoksi overrides, luo overrides/main.html, laajenna base.html-mallipohjaa ja lisää asynkroninen lataaja scripts-lohkoon super()-kutsun jälkeen. super()-kutsu säilyttää Materialin haussa ja navigoinnissa käyttämät komentosarjat.

Havainnollistava keskustelu — ei live-chat.

Palvelun tarjoaa ChattyBox
Material for MkDocs -mobiilisivu, jolla haku ja ChattyBox näkyvät peittämättä käyttöliittymän ohjaimia
Alkuperäinen mobiiliviite: haku on edelleen käytettävissä, käynnistysohjelmassa on käyttökelpoinen kosketuskohde, eikä sivu vieritä vaakasuunnassa.
Asennuspolku

Widgetin lisääminen MkDocsiin

Aseta Material for MkDocsissa theme.custom_dir arvoon overrides, laajenna base.html tiedostossa overrides/main.html ja kutsu super() ennen asynkronista widget-skriptiä. Vanilla MkDocs tarvitsee oman mukautetun teemahakemiston ja vastaavan main.html-ohituksen.

  1. 1Luo ChattyBox-projekti ja kirjoita MkDocs- tai Material for MkDocs -sivustosi URL-osoite tai sivustokartta.
  2. 2Testaa todellisia MkDocs-kysymyksiä hallintapaneelissa ja varmista, että lähdeviitteet osoittavat oikeille sivuille.
  3. 3Lisää testattu ohitus, rakenna sivusto ja varmista haku, navigointi, CSP ja mobiilikäyttäytyminen.
overrides/main.html
html
{% extends "base.html" %}

{% block scripts %}
  {{ super() }}
  <script
    id="chattybox-widget"
    src="https://chattybox.ai/widget.js"
    async
    data-api-key="YOUR_API_KEY"
    data-api-url="https://adorable-woodpecker-629.convex.site/chat"
    data-chattybox-widget="true"
  ></script>
{% endblock %}
UKK

Yleisiä kysymyksiä

1

Toimiiko ChattyBox Material for MkDocs:n kanssa?

Kyllä. ChattyBox voi hakea julkisia MkDocs- ja Material for MkDocs -sivuja, ja sen voi upottaa tavallisena verkkosivustowidgetinä.

2

Pitääkö minun vaihtaa Python-rakennusputkistoani?

Ei. Lisää widget-koodinpätkä sivustosi malliin tai teeman ohitukseen, kun olet määrittänyt chatbotin.

3

Voiko robotti vastata versioiduista asiakirjoista?

Kyllä, jos versioidut asiakirjasivut ovat julkisia ja sisältyvät indeksointiin tai sivustokarttaan.

4

Voiko se tunnistaa asiakirjojen aukkoja?

Pro- ja Business-paketeissa merkityt kysymykset ovat heuristisia merkkejä, joiden avulla voit selvittää mahdollisia sisältöaukkoja. Ne eivät ole lopullisia diagnooseja MkDocs-sisällöstäsi.