Preskoči na vsebino

Docusaurus

Sinhronizirajte svojo Docusaurus dokumentacijsko stran v bazo znanja AI SmartTalk. Vaša AI se bo učila iz vsake strani v vaši zemljevidu strani—popolno za podporne bote, ki odgovarjajo na tehnična vprašanja.


Pregled

Integracija Docusaurus vam omogoča:

  • Uvoz vseh strani iz vašega zemljevida strani samodejno
  • Ohranjanje sinhronizacije dokumentov ob objavi posodobitev
  • Odgovarjanje na vprašanja o vaši dokumentaciji pogovorno
  • Zmanjšanje obremenitve podpore s tem, da AI obravnava pogosta vprašanja

Zanimiv podatek: Dokumentacija AI SmartTalk uporablja Docusaurus, in ta integracija poganja naš podporni klepetalnik!


Predpogoji

Preden začnete, se prepričajte, da imate:

  • Aktivno AI SmartTalk račun
  • Docusaurus stran z veljavnim sitemap.xml
  • Vaša stran mora biti javno dostopna (ali zagotovite avtentikacijo)

Korak 1: Najdite svoj zemljevid strani

Docusaurus samodejno generira zemljevid strani. Najdete ga na:

https://your-docs-site.com/sitemap.xml

Preverite, ali se naloži v vašem brskalniku in vsebuje vaše dokumentacijske strani.

Korak 2: Dodajte integracijo Docusaurus

  1. Prijavite se v svoj AI SmartTalk račun
  2. Pojdite na NastavitveIntegracije
  3. Poiščite Docusaurus in kliknite Poveži
  4. Vnesite URL vašega zemljevida strani
  5. Kliknite Potrdi

Korak 3: Konfigurirajte nastavitve uvoza

Po potrditvi konfigurirajte svoj uvoz:

NastavitevOpis
URL zemljevida straniPoln URL do vašega sitemap.xml
Vključite vzorceSinhronizirajte samo strani, ki ustrezajo vzorcem (neobvezno)
Izključite vzorcePreskočite določene strani ali odseke (neobvezno)

Korak 4: Začnite uvoz

  1. Kliknite Uvozi strani
  2. AI SmartTalk preišče vsak URL v vašem zemljevidu strani
  3. Vsebina se izloči in doda vaši bazi znanja
  4. Počakajte, da se uvoz zaključi (napredek prikazan)

Korak 5: Preverite uvoz

  1. Pojdite na Znanje v AI SmartTalk
  2. Vaše dokumentacijske strani bi se morale prikazati
  3. Preizkusite svojo AI tako, da postavite vprašanja o vaših dokumentih

Kaj se sinhronizira

VsebinaKako se obdeluje
Naslov straniUporablja se kot identifikator dokumenta
Vsebina straniCelotno besedilo, izločeno iz HTML
NasloviOhranjeni za strukturo
KodaVključena takšna, kot je
TabelePretvorjene v berljiv format
URL-jiURL strani shranjen za referenco

Izločanje vsebine

AI SmartTalk izloči glavno območje vsebine in ignorira:

  • Navigacijske menije
  • Stranske vrstice
  • Noge
  • Skripte in sloge

Obnašanje sinhronizacije

Ročni uvoz

Kliknite Uvozi v nastavitvah integracije, da:

  • Pridobite najnovejši zemljevid strani
  • Dodate nove strani
  • Posodobite spremenjene strani
  • Odstranite izbrisane strani

Ohranitev dokumentacije sveže

Za vedno aktualno dokumentacijo:

  1. Ročno osveževanje: Kliknite Uvozi po objavi posodobitev
  2. Načrtovana sinhronizacija: Uporabite SmartFlow za avtomatizacijo uvozov

Načrtovan uvoz SmartFlow

Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml

URL vzorci

Vključite vzorce

Sinhronizirajte samo določene odseke:

VzorecUčinek
/docs/api/*Samo dokumentacija API
/docs/guides/*Samo oddelek vodičev
/blog/*Samo objave na blogu

Izključite vzorce

Preskočite določene strani:

VzorecUčinek
/docs/internal/*Preskočite notranje dokumente
/changelogPreskočite stran s spremembami
*/draft-*Preskočite osnutke strani

Uporabniški primeri

Tehnična podpora

Sinhronizirajte dokumentacijo vašega izdelka:

  • "Kako namestim SDK?"
  • "Kakšne so omejitve API?"
  • "Prikaži mi primer avtentikacije"

Dokumentacija za razvijalce

Sinhronizirajte API reference in vodiče:

  • "Katere parametre sprejema končna točka /users?"
  • "Kako obvladujem webhooke?"
  • "Kakšna je razlika med API v1 in v2?"

Notranja baza znanja

Sinhronizirajte podjetniške wike in postopke:

  • "Kakšen je postopek za zahtevo za PTO?"
  • "Kako nastavim svoje razvojno okolje?"
  • "Kje najdem smernice za blagovno znamko?"

Odpravljanje težav

Težave z zemljevidom strani

TežavaRešitev
"Neveljaven zemljevid strani"Preverite, ali URL vrača veljaven XML
"Nobene strani niso bile najdene"Preverite, ali zemljevid strani vsebuje <url> vnose
"Dostop zavrnjen"Prepričajte se, da je zemljevid strani javno dostopen

Težave pri uvozu

TežavaRešitev
Manjkajoče straniPreverite vključitvene/izključitvene vzorce
Uvoz se je ustavilVelike strani potrebujejo čas; počakajte ali uvozite v serijah
Stara vsebinaPonovno uvozite, da pridobite najnovejše različice

Kakovost vsebine

TežavaRešitev
Napačna vsebina je bila izvlečenaPoročite o težavi—morda bo potrebna prilagojena ekstrakcija
Manjkajoči kodni blokiPreverite, ali je koda v standardnih <pre><code> oznakah
Zmedeno besediloPreverite kodiranje strani (priporočeno UTF-8)

Upravljanje integracije

DejanjeKako
Ponovno uvozi vseKliknite Uvozi v nastavitvah integracije
Spremeni zemljevid straniPosodobite URL in ponovno uvozite
Odstrani vsebinoPrekinite integracijo ali izbrišite iz znanja
Prekini povezavoNastavitve → Integracije → Docusaurus → Prekini povezavo

Najboljše prakse

  1. Kakovostna vsebina: Dobro napisani dokumenti = boljši odgovori AI
  2. Jasna struktura: Uporabite naslove, sezname in tabele
  3. Opisni naslovi: Naslovi strani pomagajo AI razumeti kontekst
  4. Redno usklajevanje: Ohranite AI posodobljenega z najnovejšo dokumentacijo
  5. Temeljito testiranje: Postavite pogosta vprašanja za preverjanje natančnosti AI

Nasveti za konfiguracijo Docusaurusa

Optimizacija za ekstrakcijo AI

V vašem docusaurus.config.js:

module.exports = {
// Ensure sitemap is generated
plugins: ['@docusaurus/plugin-sitemap'],

// Use descriptive page titles
title: 'Your Product Docs',

// Include metadata
themeConfig: {
metadata: [{
name: 'description',
content: 'Documentation for Your Product'
}],
},
};

Izključitev strani iz zemljevida spletnega mesta

Da preprečite sinhronizacijo določenih strani:

// In page frontmatter
---
title: Internal Page
sitemap:
exclude: true
---

Sorodna dokumentacija

Pripravljeni, da dvignete svojo
uporabniško izkušnjo?

Uvedite AI asistente, ki navdušijo stranke in se prilagajajo vašemu podjetju.

Skladno z GDPR