Přeskočit na hlavní obsah

Docusaurus

Synchronizujte svou dokumentační stránku Docusaurus do znalostní báze AI SmartTalk. Vaše 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 publikování aktualizací
  • Odpovídat na otázky o vaší dokumentaci konverzačně
  • Snížit zátěž podpory tím, že AI zvládne běžné otázky

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


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čítá 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 SitemapPlná URL k vašemu sitemap.xml
Včetně vzorůSynchronizovat pouze stránky odpovídající vzorům (volitelné)
Vyloučení vzorů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 je 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 svou AI tím, že se zeptáte na otázky o vašich dokumentech

Co se synchronizuje​

ObsahJak je zpracován
Název stránkyPoužívá se jako identifikátor dokumentu
Obsah stránkyÚplný text extrahovaný z HTML
NadpisyZachovány pro strukturu
Kódové blokyZahrnuty tak, jak jsou
TabulkyPřeváděny do čitelného formátu
URLURL 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 Importovat 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í dokumentů aktuálních​

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 pro automatizaci importů

Plánovaný import SmartFlow​

Workflow: Docusaurus Auto-Sync
Trigger: Plánováno (Denně v 3:00)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml

Vzory URL​

Vzory pro zahrnutí​

Synchronizujte pouze konkrétní sekce:

VzorEfekt
/docs/api/*Pouze dokumentace API
/docs/guides/*Pouze sekce průvodců
/blog/*Pouze příspěvky na blogu

Vzory pro vyloučení​

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

VzorEfekt
/docs/internal/*Přeskočit interní dokumenty
/changelogPřeskočit stránku s historií změn
*/draft-*Přeskočit návrhové stránky

Případové studie​

Technický podpůrný bot​

Synchronizujte svou produktovou dokumentaci:

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

Dokumentace pro vývojáře​

Synchronizujte API reference a průvodce:

  • "Jaké parametry akceptuje koncový bod /users?"
  • "Jak zpracovávám webhooks?"
  • "Jaký je rozdíl mezi API v1 a v2?"

Interní znalostní báze​

Synchronizujte firemní wiki a postupy:

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

Řešení problémů​

Problémy se Sitemap​

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"Ujistěte se, že je sitemap veřejně přístupný

Problémy s importem​

ProblémŘešení
Chybějící stránkyZkontrolujte vzory pro zahrnutí/vyloučení
Import se zaseklVelké stránky trvají déle; počkejte nebo importujte po dávkách
Starý obsahZnovu importujte pro získání nejnovějších verzí

Kvalita obsahu​

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

Správa integrace​

AkceJak
Znovu importovat všeKlikněte na Import v nastavení integrace
Změnit sitemapAktualizujte URL a znovu importujte
Odebrat obsahOdpojte integraci nebo odstraňte ze Znalostí
OdpojitNastavení → Integrace → Docusaurus → Odpojit

Nejlepší praktiky​

  1. Kvalitní obsah: Dobře napsané dokumenty = 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 aktualizovanou s nejnovější dokumentací
  5. Důkladné testování: Ptejte se na běžné otázky 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 sitemap generován
plugins: ['@docusaurus/plugin-sitemap'],

// Používejte popisné názvy stránek
title: 'Dokumentace vašeho produktu',

// Zahrnout metadata
themeConfig: {
metadata: [{
name: 'description',
content: 'Dokumentace pro váš produkt'
}],
},
};

Vyloučení stránek ze Sitemap​

Aby se zabránilo synchronizaci určitých stránek:

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

Související dokumentace​

Připraveni povýšit svůj
uživatelský zážitek?

Nasazujte AI asistenty, kteří potěší zákazníky a škálují s vaším podnikáním.

Soulad s GDPR