Docusaurus

Synchronizujte svoju dokumentačnú stránku Docusaurus do znalostnej bázy AI SmartTalk. Vaša AI sa naučí z každej stránky vo vašej mape stránok—ideálne pre podporné boty, ktoré odpovedajú na technické otázky.

---

Prehľad

Integrácia Docusaurus vám umožňuje:

• Importovať všetky stránky z vašej mapy stránok automaticky
• Udržiavať dokumenty synchronizované pri publikovaní aktualizácií
• Odpovedať na otázky o vašej dokumentácii konverzačne
• Znížiť záťaž podpory tým, že AI sa postará o bežné otázky

Zaujímavý fakt: Dokumentácia AI SmartTalk používa Docusaurus a táto integrácia poháňa náš podporný chatbot!

---

Predpoklady

Predtým, než začnete, zabezpečte, aby ste mali:

• Aktívny účet AI SmartTalk
• Stránku Docusaurus s platným sitemap.xml
• Vaša stránka musí byť verejne prístupná (alebo poskytnúť autentifikáciu)

---

Krok za krokom nastavenie

Krok 1: Nájdite svoju mapu stránok

Docusaurus automaticky generuje mapu stránok. Nájdite ju na:

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

Overte, či sa načíta vo vašom prehliadači a obsahuje vaše dokumentačné stránky.

Krok 2: Pridajte integráciu Docusaurus

1. Prihláste sa do svojho účtu AI SmartTalk
2. Prejdite na Nastavenia → Integrácie
3. Nájdite Docusaurus a kliknite na Pripojiť
4. Zadajte URL vašej mapy stránok
5. Kliknite na Overiť

Krok 3: Konfigurujte nastavenia importu

Po overení nakonfigurujte svoj import:

Nastavenie	Popis
URL mapy stránok	Úplná URL k vášmu sitemap.xml
Zahrnúť vzory	Synchronizovať iba stránky zodpovedajúce vzorom (voliteľné)
Vylúčiť vzory	Preskočiť konkrétne stránky alebo sekcie (voliteľné)

Krok 4: Spustite import

1. Kliknite na Importovať stránky
2. AI SmartTalk prehľadáva každú URL vo vašej mape stránok
3. Obsah je extrahovaný a pridaný do vašej znalostnej bázy
4. Počkajte na dokončenie importu (zobrazený pokrok)

Krok 5: Overte import

1. Prejdite na Znalosti v AI SmartTalk
2. Vaše dokumentačné stránky by sa mali zobraziť
3. Otestujte svoju AI položením otázok o vašich dokumentoch

---

Čo sa synchronizuje

Obsah	Ako je spracovaný
Názov stránky	Používa sa ako identifikátor dokumentu
Obsah stránky	Celý text extrahovaný z HTML
Nadpisy	Zachované pre štruktúru
Kódové bloky	Zahrnuté tak, ako sú
Tabuľky	Prevedené do čitateľného formátu
URL	URL stránky uložená na referenciu

Extrakcia obsahu

AI SmartTalk extrahuje hlavnú oblasť obsahu a ignoruje:

• Navigačné menu
• Bočné panely
• Pätky
• Skripty a štýly

---

Správanie synchronizácie

Ručný import

Kliknite na Importovať v nastaveniach integrácie, aby ste:

• Načítali najnovšiu mapu stránok
• Pridali nové stránky
• Aktualizovali zmenené stránky
• Odstránili odstránené stránky

Udržiavanie dokumentov aktuálnych

Pre vždy aktuálnu dokumentáciu:

1. Ručné obnovenie: Kliknite na Importovať po publikovaní aktualizácií
2. Plánovaná synchronizácia: Použite SmartFlow na automatizáciu importov

Plánovaný import SmartFlow

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

---

Vzory URL

Zahrnúť vzory

Synchronizujte iba konkrétne sekcie:

Vzor	Efekt
/docs/api/*	Iba dokumentácia API
/docs/guides/*	Iba sekcia sprievodcov
/blog/*	Iba príspevky na blogu

Vylúčiť vzory

Preskočte určité stránky:

Vzor	Efekt
/docs/internal/*	Preskočiť interné dokumenty
/changelog	Preskočiť stránku s históriou zmien
*/draft-*	Preskočiť návrhové stránky

---

Prípady použitia

Technický podporný bot

Synchronizujte svoju produktovú dokumentáciu:

• "Ako nainštalujem SDK?"
• "Aké sú limity API?"
• "Ukážte mi príklad autentifikácie"

Dokumentácia pre vývojárov

Synchronizujte referencie API a sprievodcov:

• "Aké parametre akceptuje koncový bod /users?"
• "Ako spracovávam webhooky?"
• "Aký je rozdiel medzi API v1 a v2?"

Interná znalostná báza

Synchronizujte firemné wiki a postupy:

• "Aký je proces žiadania o PTO?"
• "Ako si nastavím svoje vývojové prostredie?"
• "Kde nájdem smernice pre značku?"

---

Riešenie problémov

Problémy s mapou stránok

Problém	Riešenie
"Neplatná mapa stránok"	Overte, či URL vracia platný XML
"Nenašli sa žiadne stránky"	Skontrolujte, či mapa stránok obsahuje <url> záznamy
"Prístup zamietnutý"	Uistite sa, že mapa stránok je verejne prístupná

Problémy s importom

Problém	Riešenie
Chýbajúce stránky	Skontrolujte vzory zahrnutia/vylúčenia
Import uviazol	Veľké stránky trvajú dlhšie; počkajte alebo importujte po častiach
Starý obsah	Znovu importujte, aby ste získali najnovšie verzie

Kvalita obsahu

Problém	Riešenie
Nesprávny obsah extrahovaný	Nahláste problém—môže byť potrebná vlastná extrakcia
Chýbajúce kódové bloky	Overte, či je kód v štandardných <pre><code> značkách
Rozmazaný text	Skontrolujte kódovanie stránky (odporúča sa UTF-8)

---

Správa integrácie

Akcia	Ako
Znovu importovať všetko	Kliknite na Importovať v nastaveniach integrácie
Zmeniť mapu stránok	Aktualizujte URL a znovu importujte
Odstrániť obsah	Odpojte integráciu alebo odstráňte zo Znalostí
Odpojiť	Nastavenia → Integrácie → Docusaurus → Odpojiť

---

Najlepšie praktiky

1. Kvalitný obsah: Dobre napísané dokumenty = lepšie odpovede AI
2. Jasná štruktúra: Používajte nadpisy, zoznamy a tabuľky
3. Popisné názvy: Názvy stránok pomáhajú AI pochopiť kontext
4. Pravidelné synchronizácie: Udržujte AI aktualizovanú s najnovšou dokumentáciou
5. Dôkladne testujte: Pýtajte sa bežných otázok, aby ste overili presnosť AI

---

Tipy na konfiguráciu Docusaurus

Optimalizujte pre extrakciu AI

Vo vašom docusaurus.config.js:

module.exports = {
  // Zabezpečte, aby sa mapa stránok generovala
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Používajte popisné názvy stránok
  title: 'Dokumentácia vášho produktu',
  
  // Zahrňte metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentácia pre váš produkt'
    }],
  },
};

Vylúčiť stránky z mapy stránok

Aby ste zabránili synchronizácii určitých stránok:

// V prednej časti stránky
---
title: Interná stránka
sitemap:
  exclude: true
---

---

Súvisiaca dokumentácia

• Prehľad integrácií
• Správa znalostnej bázy
• Integrácia RSS Feed — Pre obsah blogu/noviniek
• Plánované spúšťače SmartFlow — Automatizujte importy