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 risināt biežus jautājumus

Interesants fakts: AI SmartTalk paša 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 vietnei jābūt publiski pieejamai (vai jānodrošina autentifikācija)

---

Soli 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ūkprogrammā un satur jūsu dokumentācijas lapas.

2. solis: Pievienojiet Docusaurus integrāciju

1. Piesakieties 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 importa 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 paraugus	Sinhronizēt tikai lapas, kas atbilst paraugiem (pēc izvēles)
Izslēgt paraugus	Izlaist noteiktas 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, kamēr imports pabeidzas (progresu rā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 izvilkts no HTML
Virsraksti	Saglabāti struktūrai
Koda bloki	Iekļauti tādi, kādi ir
Tabulas	Pārvērstas lasāmā formātā
URLs	Lapas URL saglabāts atsaucei

Satura izvilkšana

AI SmartTalk izvelk galveno satura zonu un ignorē:

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

---

Sinhronizācijas uzvedība

Manuāla importēšana

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. Manuāla atsvaidzināšana: Noklikšķiniet uz Importēt pēc atjauninājumu publicēšanas
2. Plānota sinhronizācija: Izmantojiet SmartFlow, lai automatizētu importēšanu

SmartFlow plānotā importēšana

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 bots

Sinhronizējiet savu produktu dokumentāciju:

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

Izstrādātāju dokumentācija

Sinhronizējiet API atsauces un rokasgrāmatas:

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

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

Sinhronizējiet uzņēmuma vikipēdijas un procedūras:

• "Kāds ir process PTO pieprasīšanai?"
• "Kā man izveidot 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ļaušanas/izslēgšanas modeļus
Importēšana iestrēgusi	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
Sajaukti teksti	Pārbaudiet lapas kodējumu (ieteicams UTF-8)

---

Integrācijas pārvaldība

Darbība	Kā
Atkārtoti importēt visu	Noklikšķiniet uz Importēt integrācijas iestatījumos
Mainīt vietnes karti	Atjauniniet URL un atkārtoti importējiet
Noņemt saturu	Atvienojiet integrāciju vai dzēsiet no Zināšanu bāzes
Atvienot	Iestatījumi → Integrācijas → Docusaurus → Atvienot

---

Labākās prakses

1. Kvalitatīvs saturs: Labi rakstīti dokumenti = labāki AI atbildes
2. Skaidra struktūra: Izmantojiet virsrakstus, sarakstus un tabulas
3. Aprakstoši virsraksti: Lappušu virsraksti palīdz AI saprast kontekstu
4. Regulāras sinhronizācijas: Uzturiet AI atjauninātu ar jaunāko dokumentāciju
5. Rūpīgi testējiet: Uzdodiet bieži uzdotos 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 lappušu virsrakstus
  title: 'Jūsu produkta dokumentācija',
  
  // Iekļaujiet metadatus
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentācija Jūsu produktam'
    }],
  },
};

Izslēdziet lappuses no vietnes kartes

Lai novērstu noteiktu lappušu sinhronizāciju:

// Lappuses priekšmeta daļā
---
title: Iekšējā lappuse
sitemap:
  exclude: true
---

---

Saistītā dokumentācija

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