Docusaurus

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

---

Ülevaade

Docusaurus integreerimine võimaldab sul:

• Importida automaatselt kõik lehed oma saidikaardilt
• Hoidke 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 Docusaurust ja see integreerimine toidab 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 dokumentatsioonilehti.

Samm 2: Lisa Docusaurus integreerimine

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

Samm 3: Konfigureeri impordi seaded

Pärast kinnitamist konfigureeri oma import:

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

Samm 4: Alusta importimist

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

Samm 5: Kinnita import

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

---

Mis sünkroniseeritakse

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

Sisu ekstraktsioon

AI SmartTalk ekstrakteerib peamise sisu ala ja ignoreerib:

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

---

Sünkroloogika

Käsitsi Importimine

Klõpsake Import integreerimise seadetes, et:

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

Dokumentide Aja Jooksul Uuendamine

Kuna dokumentatsioon on alati ajakohane:

1. Käsitsi värskendamine: Klõpsake Import pärast uuenduste avaldamist
2. Ajastatud sünkroonimine: Kasutage SmartFlow'd importide 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

Kaasa Arvatud Mustrid

Sünkroonige ainult spetsiifilised osad:

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

Välja Jätmise Mustrid

Jätke teatud lehed vahele:

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

---

Kasutuse Juhud

Tehnilise Toe Bot

Sünkroonige oma tootedokumentatsioon:

• "Kuidas ma installin SDK?"
• "Millised on API kiiruspiirangud?"
• "Näidake 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 wikisid ja protseduure:

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

---

Probleemide Lahendamine

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

Importimise Probleemid

Probleem	Lahendus
Lehed puuduvad	Kontrollige kaasamise/välja jätmise mustreid
Import kinni	Suured saidid võtavad aega; oodake või importige osade kaupa
Vana sisu	Uuesti importige, et saada uusimad versioonid

Sisu Kvaliteet

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

---

Integreerimise Haldamine

Tegevus	Kuidas
Uuesti importida kõik	Klõpsake Import integreerimise seadetes
Muuda saidikaarti	Uuendage URL-i ja importige uuesti
Eemaldage sisu	Ühendage integreerimine või kustutage Teadmistebaasist
Ühenduse katkestamine	Seaded → Integreerimised → Docusaurus → Ühenduse katkestamine

---

Parimad praktikad

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 viimase dokumentatsiooniga kursis
5. Testige põhjalikult: Esitage tavalisi küsimusi, et kontrollida AI täpsust

---

Docusaurus konfiguratsiooni näpunäited

Optimeerimine AI ekstraktsiooni jaoks

Teie docusaurus.config.js failis:

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

Lehtede välistamine saidikaardilt

Teatud lehtede sünkroonimise vältimiseks:

// Lehe esiküljel
---
title: Sisemine leht
sitemap:
  exclude: true
---

---

Seotud dokumentatsioon

• Integratsioonide ülevaade
• Teadmistebaasi haldamine
• RSS-voo integratsioon — Blogi/uudiste sisu jaoks
• SmartFlow ajastatud käivitajad — Impordiprotsesside automatiseerimine