Docusaurus

Sünkroniseeri oma Docusaurus dokumentatsiooni sait AI SmartTalki teadmistebaasiga. Sinu AI õpib igast leheküljest sinu saidikaardil — ideaalne tehniliste küsimuste vastamiseks mõeldud tugibotide jaoks.

---

Ü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 levinud küsimusi

Huvitav fakt: AI SmartTalki enda dokumentatsioon kasutab Docusaurus't ning 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-sammuline seadistamine

Samm 1: Leia oma Saidikaart

Docusaurus genereerib automaatselt saidikaardi. Leia see aadressilt:

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

Kontrolli, et see laadib 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-i sinu saidikaardil
3. Sisu ekstraheeritakse ja lisatakse sinu teadmistebaasi
4. Oota, kuni importimine on lõpetatud (edusammud kuvatakse)

Samm 5: Kinnita Importimine

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
Koodiblokid	Lisatakse sellisena nagu nad on
Tabelid	Muudetakse loetavaks formaadiks
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ünkroniseerimise Käitumine

Käsitsi Importimine

Kliki Import integratsiooni seadetes, et:

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

Dokumentide Aeg-ajalt Uuendamine

Kuna dokumentatsioon on alati ajakohane:

1. Käsitsi värskendamine: Kliki Import pärast uuenduste avaldamist
2. Ajastatud sünkroniseerimine: Kasuta SmartFlow'd importide automatiseerimiseks

SmartFlow Ajastatud Import

Workflow: Docusaurus Auto-Sync
Trigger: Ajastatud (Iga päev kell 3:00)
Actions:
  - Sync Connector:
      Type: Docusaurus
      Sitemap: https://docs.example.com/sitemap.xml

---

URL Mustrid

Sisesta Mustrid

Sünkroniseeri ainult konkreetsed sektsioonid:

Muster	Efekt
/docs/api/*	Ainult API dokumentatsioon
/docs/guides/*	Ainult juhendite sektsioon
/blog/*	Ainult blogipostitused

Välista Mustrid

Jäta välja teatud lehed:

Muster	Efekt
/docs/internal/*	Jäta välja sisemised dokumendid
/changelog	Jäta välja muudatuste leht
*/draft-*	Jäta välja mustandite lehed

---

Kasutuse Näited

Tehnilise Toe Bot

Sünkroniseeri oma toote dokumentatsioon:

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

Arendaja Dokumentatsioon

Sünkroniseeri 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ünkroniseeri ettevõtte wikisid ja protseduure:

• "Mis on PTO taotlemise protsess?"
• "Kuidas ma seadistan oma arenduskeskkonna?"
• "Kus ma leian brändijuhised?"

---

Probleemide Lahendamine

Saidikaardi Probleemid

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

Importimise Probleemid

Probleem	Lahendus
Lehed puuduvad	Kontrolli sisesta/välista mustreid
Import kinni	Suured saidid võtavad aega; oota või impordi osade kaupa
Vana sisu	Taasta import, et saada uusimad versioonid

Sisu Kvaliteet

Probleem	Lahendus
Vale sisu ekstraheeritud	Teata probleemist — võib vajada kohandatud ekstraheerimist
Puuduvad koodiblokid	Kontrolli, et kood on standardsetes <pre><code> siltides
Segane tekst	Kontrolli lehe kodeeringut (soovitatav on UTF-8)

---

Integratsiooni Halduse

Tegevus	Kuidas
Taasta kõik	Kliki Import integratsiooni seadetes
Muuda saidikaarti	Uuenda URL ja taasta import
Eemalda sisu	Ühenda integratsioon või kustuta Teadmistest
Ühenda lahti	Seaded → Integratsioonid → Docusaurus → Ühenda lahti

---

Parimad Praktikad

1. Kvaliteetne sisu: Hästi kirjutatud dokumendid = paremad AI vastused
2. Selge struktuur: Kasuta pealkirju, loendeid ja tabeleid
3. Kirjeldavad pealkirjad: Lehe pealkirjad aitavad AI-l konteksti mõista
4. Regulaarsed sünkroniseerimised: Hoia AI ajakohasena viimase dokumentatsiooniga
5. Testi põhjalikult: Esita levinud küsimusi, et kontrollida AI täpsust

---

Docusaurus Konfiguratsiooni Näpunäited

Optimeeri AI Ekstraheerimiseks

Oma docusaurus.config.js failis:

module.exports = {
  // Veendu, et saidikaart genereeritakse
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Kasuta kirjeldavaid lehe pealkirju
  title: 'Sinu Toote Dokumendid',
  
  // Lisa metaandmed
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentatsioon Sinu Toote kohta'
    }],
  },
};

Välista Lehed Saidikaardilt

Teatud lehtede sünkroniseerimise vältimiseks:

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

---

Seotud Dokumentatsioon

• Integratsioonide Ülevaade
• Teadmistebaasi Halduse
• RSS Toite Integratsioon — Blogi/uudiste sisu jaoks
• SmartFlow Ajastatud Käivitajad — Automatiseeri importimised