Docusaurus

Sünkroniseeri oma Docusaurus dokumentatsiooni sait AI SmartTalki teadmistebaasiga. Sinu AI õpib igast leheküljest sinu saidikaardil—täiuslik tugibotidele, mis vastavad tehnilistele küsimustele.

---

Ülevaade

Docusaurus integratsioon võimaldab sul:

• Importida automaatselt kõik lehed oma saidikaardilt
• Hoida dokumendid sünkroonis, kui avaldad uuendusi
• Vastata küsimustele oma dokumentatsiooni kohta vestluslikult
• Vähendada tugikoormust lastes AI-l hallata tavalisi küsimusi

Lõbus fakt: AI SmartTalki enda dokumentatsioon kasutab Docusaurus't, ja see integratsioon toetab meie tugichatboti!

---

Eeltingimused

Enne alustamist veendu, et sul on:

• Aktiivne AI SmartTalki konto
• Docusaurus sait, millel on kehtiv sitemap.xml
• Sinu sait peab olema avalikult ligipääsetav (või pakkuma autentimist)

---

Samm-sammult seadistamine

Samm 1: Leia oma saidikaart

Docusaurus genereerib automaatselt saidikaardi. Leia see aadressilt:

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

Kontrolli, et see laeb sinu brauseris ja sisaldab sinu dokumentatsiooni lehti.

Samm 2: Lisa Docusaurus integratsioon

1. Logi sisse oma AI SmartTalki kontole
2. Mine Seaded → Integratsioonid
3. Leia Docusaurus ja kliki Ühenda
4. Sisesta oma saidikaardi URL
5. Kliki Kinnita

Samm 3: Konfigureeri importimise seaded

Pärast kinnitamist konfigureeri oma import:

Seade	Kirjeldus
Saidikaardi URL	Täielik URL sinu sitemap.xml-ile
Sisesta mustrid	Sünkroniseeri ainult lehed, mis vastavad mustritele (valikuline)
Välista mustrid	Jäta välja konkreetsed lehed või sektsioonid (valikuline)

Samm 4: Alusta importimist

1. Kliki Importi lehed
2. AI SmartTalk indekseerib iga URL sinu saidikaardil
3. Sisu ekstraheeritakse ja lisatakse sinu teadmistebaasi
4. Oota, kuni importimine on lõpetatud (edusammud kuvatakse)

Samm 5: Kinnita import

1. Mine Teadmised AI SmartTalkis
2. Sinu dokumentatsiooni lehed peaksid ilmuma
3. Testi oma AI-d, esitades küsimusi oma dokumentide kohta

---

Mis sünkroniseeritakse

Sisu	Kuidas seda töödeldakse
Lehe pealkiri	Kasutatakse dokumendi tuvastajana
Lehe sisu	Täisteksti ekstraheeritakse HTML-ist
Pealkirjad	Säilitatakse struktuuri jaoks
Koodiplokid	Lisatakse sellisena nagu need on
Tabelid	Muudetakse loetavasse vormingusse
URL-id	Lehe URL salvestatakse viitamiseks

Sisu ekstraheerimine

AI SmartTalk ekstraheerib peamise sisu ala ja ignoreerib:

• Navigeerimismenüüd
• Küljepaneelid
• Jalused
• Skriptid ja stiilid

---

Sünkrooni Käitumine

Käsiimpordi

Klõpsake Import integratsiooni seadetes, et:

• Tõmmata uusim saidikaart
• Lisada uusi lehti
• Uuendada muudetud lehti
• Eemaldada kustutatud lehti

Dokumentide Aja Jooksul Uuendamine

Kuna dokumendid on alati ajakohased:

1. Käsiuuendus: Klõpsake Import pärast uuenduste avaldamist
2. Ajastatud sünkroonimine: Kasutage SmartFlow'd impordiprotsessi automatiseerimiseks

SmartFlow Ajastatud Import

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

---

URL Mustrid

Sisestamise Mustrid

Sünkroonige ainult spetsiifilised osad:

Muster	Mõju
/docs/api/*	Ainult API dokumentatsioon
/docs/guides/*	Ainult juhendite osa
/blog/*	Ainult blogipostitused

Väljaarvamise Mustrid

Jätke teatud lehed vahele:

Muster	Mõju
/docs/internal/*	Jätke sisemised dokumendid vahele
/changelog	Jätke muudatuste logi leht vahele
*/draft-*	Jätke mustandlehed vahele

---

Kasutuse Näited

Tehniline Tugi Bot

Sünkroonige oma toote dokumentatsioon:

• "Kuidas ma installin SDK?"
• "Millised on API kiiruspiirangud?"
• "Näita mulle autentimise näidet"

Arendaja Dokumentatsioon

Sünkroonige API viidatud ja juhendid:

• "Milliseid parameetreid aktsepteerib /users lõpp-punkt?"
• "Kuidas ma käsitlen veebihooke?"
• "Mis vahe on v1 ja v2 API-l?"

Sisemine Teadmistebaas

Sünkroonige ettevõtte vikid ja protseduurid:

• "Mis on PTO taotlemise protsess?"
• "Kuidas ma seadistan oma arenduskeskkonna?"
• "Kust ma leian brändi juhised?"

---

Tõrkeotsing

Saidikaardi Probleemid

Probleem	Lahendus
"Kehtetu saidikaart"	Kontrollige, et URL tagastab kehtiva XML-i
"Lehti ei leitud"	Kontrollige, et saidikaart sisaldab <url> kirjeid
"Juurdepääs keelatud"	Veenduge, et saidikaart on avalikult ligipääsetav

Impordi Probleemid

Probleem	Lahendus
Lehed puuduvad	Kontrollige sisestamise/väljaarvamise mustreid
Import on kinni	Suured saidid võtavad aega; oodake või impordige partii kaupa
Vana sisu	Uuesti impordige, et tõmmata uusimad versioonid

Sisu Kvaliteet

Probleem	Lahendus
Vale sisu on välja tõmmatud	Teatage probleemist—võib-olla on vajalik kohandatud väljatõmme
Puuduvad koodiplokid	Kontrollige, et kood on standardsetes <pre><code> siltides
Segane tekst	Kontrollige lehe kodeeringut (soovitatav on UTF-8)

---

Integreerimise Halduse

Tegevus	Kuidas
Kogu uuesti importimine	Klõpsake Import integratsiooni seadetes
Muuda saidikaarti	Uuendage URL-i ja impordige uuesti
Eemaldage sisu	Ühendage integratsioon või kustutage Teadmistest
Ühenduse katkestamine	Seaded → Integreerimised → Docusaurus → Ühenduse katkestamine

---

Parimad Tavad

1. Kvaliteetne sisu: Hästi kirjutatud dokumendid = paremad AI vastused
2. Selge struktuur: Kasutage pealkirju, loendeid ja tabeleid
3. Kirjeldavad pealkirjad: Lehe pealkirjad aitavad AI-l konteksti mõista
4. Regulaarsed sünkroonimised: Hoidke AI-d värskendatuna viimase dokumentatsiooniga
5. Testige põhjalikult: Esitage tavalisi küsimusi, et kontrollida AI täpsust

---

Docusaurus Konfiguratsiooni Näpunäited

Optimeerimine AI Ekstraktsiooniks

Teie docusaurus.config.js failis:

module.exports = {
  // Veenduge, et saidikaart genereeritakse
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Kasutage kirjeldavaid lehe pealkirju
  title: 'Teie Toote Dokumentatsioon',
  
  // Lisage metaandmed
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentatsioon Teie Toote jaoks'
    }],
  },
};

Lehtede Väljaarvamine Saidikaardilt

Teatud lehtede sünkroonimise vältimiseks:

// Lehe frontmatter'is
---
title: Sisemine Leht
sitemap:
  exclude: true
---

---

Seotud Dokumentatsioon

• Integratsioonide Ülevaade
• Teadmistebaasi Halduse
• RSS Voogude Integratsioon — Blogi/uudiste sisu jaoks
• SmartFlow Planeeritud Käivitajad — Impordiprotsesside automatiseerimine