Docusaurus

Synchronizujte svou dokumentační stránku Docusaurus do znalostní báze AI SmartTalk. Váš AI se naučí z každé stránky ve vašem sitemapu—ideální pro podpůrné boty, které odpovídají na technické otázky.

---

Přehled

Integrace Docusaurus vám umožňuje:

• Importovat všechny stránky z vašeho sitemapu automaticky
• Udržovat dokumenty synchronizované při publikaci aktualizací
• Odpovídat na otázky o vaší dokumentaci konverzačně
• Snížit zátěž podpory tím, že necháte AI řešit běžné otázky

Zajímavost: Dokumentace AI SmartTalk používá Docusaurus a tato integrace pohání našeho podpůrného chatbota!

---

Požadavky

Než začnete, ujistěte se, že máte:

• Aktivní účet AI SmartTalk
• Stránku Docusaurus s platným sitemap.xml
• Vaše stránka musí být veřejně přístupná (nebo poskytněte autentizaci)

---

Krok za krokem nastavení

Krok 1: Najděte svůj Sitemap

Docusaurus automaticky generuje sitemap. Najděte ho na:

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

Ověřte, že se načte ve vašem prohlížeči a obsahuje vaše dokumentační stránky.

Krok 2: Přidejte integraci Docusaurus

1. Přihlaste se do svého účtu AI SmartTalk
2. Přejděte na Nastavení → Integrace
3. Najděte Docusaurus a klikněte na Připojit
4. Zadejte URL vašeho sitemapu
5. Klikněte na Ověřit

Krok 3: Nakonfigurujte nastavení importu

Po ověření nakonfigurujte svůj import:

Nastavení	Popis
URL Sitemap	Kompletní URL k vašemu sitemap.xml
Vzor zahrnutí	Synchronizovat pouze stránky odpovídající vzorům (volitelné)
Vzor vyloučení	Přeskočit konkrétní stránky nebo sekce (volitelné)

Krok 4: Spusťte import

1. Klikněte na Importovat stránky
2. AI SmartTalk prochází každou URL ve vašem sitemapu
3. Obsah je extrahován a přidán do vaší znalostní báze
4. Počkejte na dokončení importu (pokrok zobrazen)

Krok 5: Ověřte import

1. Přejděte na Znalosti v AI SmartTalk
2. Vaše dokumentační stránky by se měly objevit
3. Otestujte svého AI tím, že se zeptáte na otázky ohledně vašich dokumentů

---

Co se synchronizuje

Obsah	Jak je zpracován
Název stránky	Používá se jako identifikátor dokumentu
Obsah stránky	Celý text extrahovaný z HTML
Nadpisy	Zachovány pro strukturu
Kódové bloky	Zahrnuty tak, jak jsou
Tabulky	Převedeny do čitelného formátu
URL	URL stránky uložena pro referenci

Extrakce obsahu

AI SmartTalk extrahuje hlavní oblast obsahu a ignoruje:

• Navigační menu
• Boční panely
• Patičky
• Skripty a styly

---

Chování synchronizace

Ruční import

Klikněte na Import v nastavení integrace pro:

• Načtení nejnovějšího sitemapu
• Přidání nových stránek
• Aktualizaci změněných stránek
• Odebrání smazaných stránek

Udržování dokumentace aktuální

Pro vždy aktuální dokumentaci:

1. Ruční obnovení: Klikněte na Import po publikování aktualizací
2. Plánovaná synchronizace: Použijte SmartFlow k automatizaci importů

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

---

URL vzory

Vzory pro zahrnutí

Synchronizujte pouze konkrétní sekce:

Vzor	Efekt
/docs/api/*	Pouze dokumentace API
/docs/guides/*	Pouze sekce s návody
/blog/*	Pouze příspěvky na blogu

Vzory pro vyloučení

Přeskočte určité stránky:

Vzor	Efekt
/docs/internal/*	Přeskočit interní dokumentaci
/changelog	Přeskočit stránku s historií změn
*/draft-*	Přeskočit návrhové stránky

---

Případové studie

Technická podpora

Synchronizujte dokumentaci k produktu:

• "Jak nainstaluji SDK?"
• "Jaké jsou limity API?"
• "Ukažte mi příklad autentizace"

Dokumentace pro vývojáře

Synchronizujte odkazy na API a návody:

• "Jaké parametry přijímá koncový bod /users?"
• "Jak mám zpracovávat webhooky?"
• "Jaký je rozdíl mezi API verze v1 a v2?"

Interní znalostní báze

Synchronizujte firemní wiki a postupy:

• "Jaký je proces pro žádost o PTO?"
• "Jak nastavím své vývojové prostředí?"
• "Kde najdu pokyny pro značku?"

---

Řešení problémů

Problémy se sitemapou

Problém	Řešení
"Neplatná sitemap"	Ověřte, že URL vrací platný XML
"Žádné stránky nenalezeny"	Zkontrolujte, zda sitemap obsahuje <url> položky
"Přístup odepřen"	Zajistěte, aby byla sitemap veřejně přístupná

Problémy s importem

Problém	Řešení
Chybějící stránky	Zkontrolujte vzory pro zahrnutí/vyloučení
Import uvízl	Velké stránky trvají déle; počkejte nebo importujte po dávkách
Starý obsah	Znovu importujte pro načtení nejnovějších verzí

Kvalita obsahu

Problém	Řešení
Nesprávný obsah extrahován	Nahlaste problém—může být potřeba vlastní extrakce
Chybějící bloky kódu	Ověřte, že kód je ve standardních <pre><code> značkách
Zmatený text	Zkontrolujte kódování stránky (doporučeno UTF-8)

---

Správa integrace

Akce	Jak
Znovu importovat vše	Klikněte na Import v nastavení integrace
Změnit sitemap	Aktualizujte URL a znovu importujte
Odebrat obsah	Odpojte integraci nebo smažte z Knowledge
Odpojit	Nastavení → Integrace → Docusaurus → Odpojit

---

Nejlepší praktiky

1. Kvalitní obsah: Dobře napsaná dokumentace = lepší odpovědi AI
2. Jasná struktura: Používejte nadpisy, seznamy a tabulky
3. Popisné názvy: Názvy stránek pomáhají AI pochopit kontext
4. Pravidelné synchronizace: Udržujte AI aktuální s nejnovější dokumentací
5. Důkladné testování: Kladení běžných otázek pro ověření přesnosti AI

---

Tipy pro konfiguraci Docusaurus

Optimalizace pro extrakci AI

Ve vašem docusaurus.config.js:

module.exports = {
  // Zajistěte, aby byl generován sitemap
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Používejte popisné názvy stránek
  title: 'Dokumentace k vašemu produktu',
  
  // Zahrňte metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentace k vašemu produktu'
    }],
  },
};

Vyloučení stránek ze sitemap

Aby se určité stránky nezahrnovaly do synchronizace:

// V přední části stránky
---
title: Interní stránka
sitemap:
  exclude: true
---

---

Související dokumentace

• Přehled integrací
• Správa znalostní báze
• Integrace RSS kanálu — Pro obsah blogu/novinek
• Naplánované spouštěče SmartFlow — Automatizace importů