Docusaurus

Sinchronizuokite savo Docusaurus dokumentacijos svetainę su AI SmartTalk žinių baze. Jūsų AI išmoks iš kiekvienos puslapio jūsų svetainės žemėlapyje—puikiai tinka palaikymo robotams, kurie atsako į techninius klausimus.

---

Apžvalga

Docusaurus integracija leidžia jums:

• Importuoti visus puslapius iš jūsų svetainės žemėlapio automatiškai
• Išlaikyti dokumentus sinchronizuotus, kai skelbiate atnaujinimus
• Atsakyti į klausimus apie jūsų dokumentaciją pokalbių forma
• Sumažinti palaikymo naštą leisti AI spręsti dažnus klausimus

Įdomus faktas: AI SmartTalk dokumentacija naudoja Docusaurus, o ši integracija palaiko mūsų palaikymo chatbot'ą!

---

Reikalavimai

Prieš pradėdami, įsitikinkite, kad turite:

• Aktyvią AI SmartTalk paskyrą
• Docusaurus svetainę su galiojančiu sitemap.xml
• Jūsų svetainė turi būti viešai prieinama (arba pateikti autentifikaciją)

---

Žingsnis po žingsnio nustatymas

1 žingsnis: Raskite savo svetainės žemėlapį

Docusaurus automatiškai generuoja svetainės žemėlapį. Raskite jį adresu:

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

Patikrinkite, ar jis įsikrauna jūsų naršyklėje ir ar jame yra jūsų dokumentacijos puslapiai.

2 žingsnis: Pridėkite Docusaurus integraciją

1. Prisijunkite prie savo AI SmartTalk paskyros
2. Eikite į Nustatymai → Integracijos
3. Raskite Docusaurus ir spustelėkite Prijungti
4. Įveskite savo svetainės žemėlapio URL
5. Spustelėkite Patvirtinti

3 žingsnis: Suconfigure Import Settings

Po patvirtinimo suconfigure savo importą:

Nustatymas	Aprašymas
Svetainės žemėlapio URL	Pilnas URL į jūsų sitemap.xml
Įtraukti modeliai	Sinchronizuoti tik puslapius, atitinkančius modelius (pasirinktinai)
Išskirti modeliai	Praleisti konkrečius puslapius ar skyrius (pasirinktinai)

4 žingsnis: Pradėkite importą

1. Spustelėkite Importuoti puslapius
2. AI SmartTalk naršo kiekvieną URL jūsų svetainės žemėlapyje
3. Turinys yra ištraukiamas ir pridėtas prie jūsų žinių bazės
4. Palaukite, kol importas bus baigtas (progresas rodomas)

5 žingsnis: Patikrinkite importą

1. Eikite į Žinios AI SmartTalk
2. Jūsų dokumentacijos puslapiai turėtų pasirodyti
3. Išbandykite savo AI užduodami klausimus apie savo dokumentus

---

Kas sinchronizuojama

Turinys	Kaip jis apdorojamas
Puslapio pavadinimas	Naudojamas kaip dokumento identifikatorius
Puslapio turinys	Pilnas tekstas ištrauktas iš HTML
Antraštės	Išlaikytos struktūrai
Kodo blokai	Įtraukti taip, kaip yra
Lentelės	Paverstos į skaitomą formatą
URL	Puslapio URL saugomas nuorodai

Turinys Ištraukimas

AI SmartTalk ištraukia pagrindinę turinio sritį ir ignoruoja:

• Navigacijos meniu
• Šonines juostas
• Poraštes
• Skriptus ir stilius

---

Sinchronizavimo elgesys

Rankinis importas

Spustelėkite Importuoti integracijos nustatymuose, kad:

• Gauti naujausią svetainės žemėlapį
• Pridėti naujus puslapius
• Atnaujinti pakeistus puslapius
• Pašalinti ištrintus puslapius

Dokumentų atnaujinimas

Norint, kad dokumentacija visada būtų aktuali:

1. Rankinis atnaujinimas: Spustelėkite Importuoti po atnaujinimų skelbimo
2. Planuotas sinchronizavimas: Naudokite SmartFlow automatizuoti importus

SmartFlow Planuotas Importas

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

---

URL modeliai

Įtraukti modeliai

Sinchronizuoti tik konkrečius skyrius:

Modelis	Efektas
/docs/api/*	Tik API dokumentacija
/docs/guides/*	Tik gidų skyrius
/blog/*	Tik tinklaraščio įrašai

Išskirti modeliai

Praleisti tam tikrus puslapius:

Modelis	Efektas
/docs/internal/*	Praleisti vidinę dokumentaciją
/changelog	Praleisti pakeitimų žurnalo puslapį
*/draft-*	Praleisti juodraščio puslapius

---

Naudojimo atvejai

Techninės pagalbos robotas

Sinchronizuokite savo produkto dokumentaciją:

• "Kaip man įdiegti SDK?"
• "Kokie yra API greičio limitai?"
• "Parodykite man autentifikavimo pavyzdį"

Kūrėjų dokumentacija

Sinchronizuokite API nuorodas ir gidus:

• "Kokius parametrus priima /users endpoint?"
• "Kaip man tvarkyti webhook'us?"
• "Koks skirtumas tarp v1 ir v2 API?"

Vidinė žinių bazė

Sinchronizuokite įmonės vikius ir procedūras:

• "Koks yra PTO prašymo procesas?"
• "Kaip man nustatyti savo kūrimo aplinką?"
• "Kur galiu rasti prekės ženklo gaires?"

---

Problemos sprendimas

Svetainės žemėlapio problemos

Problema	Sprendimas
"Neteisingas svetainės žemėlapis"	Patikrinkite, ar URL grąžina galiojantį XML
"Nerasta puslapių"	Patikrinkite, ar svetainės žemėlapis turi <url> įrašus
"Prieiga at拒"	Įsitikinkite, kad svetainės žemėlapis yra viešai prieinamas

Importo problemos

Problema	Sprendimas
Puslapiai trūksta	Patikrinkite įtraukti/išskirti modelius
Importas užstrigo	Didelėms svetainėms reikia laiko; palaukite arba importuokite dalimis
Senas turinys	Pakartotinai importuokite, kad gautumėte naujausias versijas

Turinys

Problema	Sprendimas
Ištrauktas neteisingas turinys	Praneškite apie problemą—gali prireikti individualaus ištraukimo
Trūksta kodo blokų	Patikrinkite, ar kodas yra standartiniuose <pre><code> žymėse
Iškreiptas tekstas	Patikrinkite puslapio kodavimą (rekomenduojama UTF-8)

---

Integracijos valdymas

Veiksmas	Kaip
Pakartotinai importuoti viską	Spustelėkite Importuoti integracijos nustatymuose
Pakeisti svetainės žemėlapį	Atnaujinkite URL ir pakartotinai importuokite
Pašalinti turinį	Atjunkite integraciją arba ištrinkite iš Žinių
Atjungti	Nustatymai → Integracijos → Docusaurus → Atjungti

---

Geriausios praktikos

1. Kokybiškas turinys: Gerai parašyta dokumentacija = geresni AI atsakymai
2. Aiški struktūra: Naudokite antraštes, sąrašus ir lenteles
3. Aprašomieji pavadinimai: Puslapio pavadinimai padeda AI suprasti kontekstą
4. Reguliarūs sinchronizavimai: Išlaikykite AI atnaujintą su naujausia dokumentacija
5. Išsamiai išbandykite: Užduokite dažnus klausimus, kad patikrintumėte AI tikslumą

---

Docusaurus konfigūracijos patarimai

Optimizuokite AI ištraukimo

Jūsų docusaurus.config.js:

module.exports = {
  // Užtikrinkite, kad svetainės žemėlapis būtų generuojamas
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Naudokite aprašomuosius puslapio pavadinimus
  title: 'Jūsų produkto dokumentacija',
  
  // Įtraukite metaduomenis
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentacija jūsų produktui'
    }],
  },
};

Išskirti puslapius iš svetainės žemėlapio

Norėdami užkirsti kelią tam tikrų puslapių sinchronizavimui:

// Puslapio frontmatter
---
title: Vidinis puslapis
sitemap:
  exclude: true
---

---

Susijusi dokumentacija

• Integracijų apžvalga
• Žinių bazės valdymas
• RSS srauto integracija — Tinklaraščio/naujienų turiniui
• SmartFlow suplanuoti įvykiai — Automatizuoti importus