Docusaurus

Sinhronizējiet savu Docusaurus dokumentācijas vietni ar AI SmartTalk zināšanu bāzi. Jūsu AI mācīsies no katras lapas jūsu vietnes kartē—ideāli piemērots atbalsta robotiem, kas atbild uz tehniskiem jautājumiem.

---

Pārskats

Docusaurus integrācija ļauj jums:

• Importēt visas lapas no jūsu vietnes kartes automātiski
• Saglabāt dokumentus sinhronizētus, kad publicējat atjauninājumus
• Atbildēt uz jautājumiem par jūsu dokumentāciju sarunvalodā
• Samazināt atbalsta slodzi, ļaujot AI apstrādāt biežākos jautājumus

Interesants fakts: AI SmartTalk pašu dokumentācija izmanto Docusaurus, un šī integrācija nodrošina mūsu atbalsta čatbotu!

---

Prasības

Pirms sākat, pārliecinieties, ka jums ir:

• Aktīva AI SmartTalk konts
• Docusaurus vietne ar derīgu sitemap.xml
• Jūsu vietne jābūt publiski pieejamai (vai jānodrošina autentifikācija)

---

Solis pa Solim Iestatīšana

1. solis: Atrodiet savu vietnes karti

Docusaurus automātiski ģenerē vietnes karti. Atrodiet to šeit:

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

Pārliecinieties, ka tā ielādējas jūsu pārlūkā un satur jūsu dokumentācijas lapas.

2. solis: Pievienojiet Docusaurus integrāciju

1. Pierakstieties savā AI SmartTalk kontā
2. Dodieties uz Iestatījumi → Integrācijas
3. Atrodiet Docusaurus un noklikšķiniet uz Savienot
4. Ievadiet savu vietnes kartes URL
5. Noklikšķiniet uz Validēt

3. solis: Konfigurējiet importēšanas iestatījumus

Pēc validācijas konfigurējiet savu importu:

Iestatījums	Apraksts
Vietnes kartes URL	Pilns URL uz jūsu sitemap.xml
Iekļaut modeļus	Sinhronizēt tikai lapas, kas atbilst modeļiem (pēc izvēles)
Izslēgt modeļus	Izlaist konkrētas lapas vai sadaļas (pēc izvēles)

4. solis: Sāciet importu

1. Noklikšķiniet uz Importēt lapas
2. AI SmartTalk pārmeklē katru URL jūsu vietnes kartē
3. Saturs tiek izvilkts un pievienots jūsu zināšanu bāzei
4. Gaidiet, līdz imports pabeidzas (progresu parādīs)

5. solis: Pārbaudiet importu

1. Dodieties uz Zināšanas AI SmartTalk
2. Jūsu dokumentācijas lapām jāparādās
3. Pārbaudiet savu AI, uzdodot jautājumus par jūsu dokumentiem

---

Kas tiek sinhronizēts

Saturs	Kā tas tiek apstrādāts
Lapas nosaukums	Izmantots kā dokumenta identifikators
Lapas saturs	Pilns teksts, kas izvilkts no HTML
Virsraksti	Saglabāti struktūrai
Koda bloki	Iekļauti tādā formā, kādā ir
Tabulas	Pārvērstas lasāmā formātā
URL	Lapas URL uzglabāts atsaucēm

Satura izvilkšana

AI SmartTalk izvelk galveno satura laukumu un ignorē:

• Navigācijas izvēlnes
• Sānjoslas
• Kājām
• Skriptus un stilus

---

Sinhronizācijas uzvedība

Roku imports

Noklikšķiniet uz Importēt integrācijas iestatījumos, lai:

• Iegūtu jaunāko vietnes karti
• Pievienotu jaunas lapas
• Atjauninātu mainītās lapas
• Noņemtu dzēstās lapas

Dokumentu atjaunināšana

Lai dokumentācija vienmēr būtu aktuāla:

1. Roku atsvaidzināšana: Noklikšķiniet uz Importēt pēc atjauninājumu publicēšanas
2. Plānotā sinhronizācija: Izmantojiet SmartFlow, lai automatizētu importus

SmartFlow plānotais imports

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

---

URL modeļi

Iekļaut modeļus

Sinhronizējiet tikai konkrētas sadaļas:

Modelis	Efekts
/docs/api/*	Tikai API dokumentācija
/docs/guides/*	Tikai rokasgrāmatu sadaļa
/blog/*	Tikai emuāra ieraksti

Izslēgt modeļus

Izlaist noteiktas lapas:

Modelis	Efekts
/docs/internal/*	Izlaist iekšējās dokumentācijas
/changelog	Izlaist izmaiņu žurnāla lapu
*/draft-*	Izlaist melnrakstu lapas

---

Lietošanas gadījumi

Tehniskā atbalsta robots

Sinhronizējiet savu produktu dokumentāciju:

• "Kā es varu instalēt SDK?"
• "Kādi ir API ātruma ierobežojumi?"
• "Parādiet man autentifikācijas piemēru"

Izstrādātāja dokumentācija

Sinhronizējiet API atsauces un rokasgrāmatas:

• "Kādi parametri tiek pieņemti /users galapunktā?"
• "Kā es varu apstrādāt webhook?"
• "Kādas ir atšķirības starp v1 un v2 API?"

Iekšējā zināšanu bāze

Sinhronizējiet uzņēmuma viki un procedūras:

• "Kāds ir PTO pieprasīšanas process?"
• "Kā es varu iestatīt savu izstrādes vidi?"
• "Kur es varu atrast zīmola vadlīnijas?"

---

Problēmu novēršana

Vietnes kartes problēmas

Problēma	Risinājums
"Nederīga vietnes karte"	Pārliecinieties, ka URL atgriež derīgu XML
"Nav atrastas lapas"	Pārbaudiet, vai vietnes karte satur <url> ierakstus
"Piekļuve liegta"	Pārliecinieties, ka vietnes karte ir publiski pieejama

Importēšanas problēmas

Problēma	Risinājums
Lapas trūkst	Pārbaudiet iekļautās/izslēgtās modeļus
Imports iestrēdzis	Lielām vietnēm nepieciešams laiks; gaidiet vai importējiet pa partijām
Vecs saturs	Atkal importējiet, lai iegūtu jaunākās versijas

Satura kvalitāte

Problēma	Risinājums
Nepareizs saturs izvilkts	Ziņojiet par problēmu—var būt nepieciešama pielāgota izvilkšana
Trūkst koda bloku	Pārliecinieties, ka kods ir standarta <pre><code> tagos
Sajaukts teksts	Pārbaudiet lapas kodējumu (ieteicams UTF-8)

---

Integrācijas pārvaldība

Rīcība	Kā
Atkal importēt visu	Noklikšķiniet uz Importēt integrācijas iestatījumos
Mainīt vietnes karti	Atjauniniet URL un atkal importējiet
Noņemt saturu	Atvienojiet integrāciju vai dzēsiet no Zināšanām
Atvienot	Iestatījumi → Integrācijas → Docusaurus → Atvienot

---

Labākās prakses

1. Kvalitatīvs saturs: Labi uzrakstītas dokumentācijas = labākas AI atbildes
2. Skaidra struktūra: Izmantojiet virsrakstus, sarakstus un tabulas
3. Aprakstoši nosaukumi: Lapas nosaukumi palīdz AI saprast kontekstu
4. Regulāras sinhronizācijas: Uzturiet AI atjauninātu ar jaunāko dokumentāciju
5. Rūpīgi pārbaudiet: Uzdodiet biežus jautājumus, lai pārbaudītu AI precizitāti

---

Docusaurus konfigurācijas padomi

Optimizējiet AI izvilkšanai

Jūsu docusaurus.config.js:

module.exports = {
  // Pārliecinieties, ka vietnes karte tiek ģenerēta
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Izmantojiet aprakstošus lapas nosaukumus
  title: 'Jūsu produkta dokumentācija',
  
  // Iekļaujiet metadatus
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentācija Jūsu produktam'
    }],
  },
};

Izslēdziet lapas no vietnes kartes

Lai novērstu noteiktu lapu sinhronizāciju:

// Lapas priekšmetā
---
title: Iekšējā lapa
sitemap:
  exclude: true
---

---

Saistītā dokumentācija

• Integrāciju pārskats
• Zināšanu bāzes pārvaldība
• RSS plūsmas integrācija — Emuāra/jaunumu saturam
• SmartFlow plānotie trigeri — Automatizējiet importus