Preskoči na hlavný obsah

Docusaurus

Synchronizujte svoju dokumentačnú stránku Docusaurus do znalostnej bázy AI SmartTalk. Váš 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ž na podporu 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!


Požiadavky

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)

Postupný návod na 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 NastaveniaIntegrácie
  3. Nájdite Docusaurus a kliknite na Pripojiť
  4. Zadajte URL svojej mapy stránok
  5. Kliknite na Overiť

Krok 3: Konfigurujte nastavenia importu

Po overení nakonfigurujte svoj import:

NastaveniePopis
URL mapy stránokÚplná URL adresa k vášmu sitemap.xml
Zahrnúť vzorySynchronizovať iba stránky zodpovedajúce vzorom (voliteľné)
Vylúčiť vzoryPreskoč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 (pokrok je zobrazený)

Krok 5: Overte import

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

Čo sa synchronizuje

ObsahAko je spracovaný
Názov stránkyPoužíva sa ako identifikátor dokumentu
Obsah stránkyCelý text extrahovaný z HTML
NadpisyZachované pre štruktúru
Kódové blokyZahrnuté tak, ako sú
TabuľkyPrevedené do čitateľného formátu
URLURL 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

Sync Behavior

Manual Import

Kliknite na Import v nastaveniach integrácie, aby ste:

  • Načítali najnovší sitemap
  • Pridali nové stránky
  • Aktualizovali zmenené stránky
  • Odstránili vymazané stránky

Keeping Docs Fresh

Pre vždy aktuálnu dokumentáciu:

  1. Manuálne obnovenie: Kliknite na Import po publikovaní aktualizácií
  2. Naplánovaná synchronizácia: Použite SmartFlow na automatizáciu importov

SmartFlow Scheduled Import

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

URL Patterns

Include Patterns

Synchronizujte iba konkrétne sekcie:

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

Exclude Patterns

Preskočte určité stránky:

PatternEffect
/docs/internal/*Preskočiť interné dokumenty
/changelogPreskočiť stránku zmien
*/draft-*Preskočiť návrhové stránky

Use Cases

Technical Support Bot

Synchronizujte dokumentáciu vášho produktu:

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

Developer Documentation

Synchronizujte referencie a sprievodcov API:

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

Internal Knowledge Base

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?"

Troubleshooting

Sitemap Issues

IssueSolution
"Invalid sitemap"Overte, či URL vracia platný XML
"No pages found"Skontrolujte, či sitemap obsahuje <url> položky
"Access denied"Uistite sa, že je sitemap verejne prístupný

Import Issues

IssueSolution
Pages missingSkontrolujte vzory zahrnutia/vylúčenia
Import stuckVeľké stránky trvajú dlhšie; počkajte alebo importujte po dávkach
Old contentZnovu importujte, aby ste načítali najnovšie verzie

Content Quality

IssueSolution
Wrong content extractedNahláste problém—môže byť potrebná vlastná extrakcia
Missing code blocksOverte, či je kód v štandardných <pre><code> značkách
Garbled textSkontrolujte kódovanie stránky (odporúča sa UTF-8)

Managing the Integration

ActionHow
Re-import allKliknite na Import v nastaveniach integrácie
Change sitemapAktualizujte URL a znovu importujte
Remove contentOdpojte integráciu alebo vymažte z Knowledge
DisconnectNastavenia → Integrácie → Docusaurus → Odpojiť

Najlepšie Praktiky

  1. Kvalitný obsah: Dobre napísaná dokumentácia = 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ôkladné testovanie: Pýtajte sa na bežné otázky na overenie presnosti AI

Tipy na Konfiguráciu Docusaurus

Optimalizácia pre Extrakciu AI

Vo vašom docusaurus.config.js:

module.exports = {
// Zabezpečte, aby sa generoval sitemap
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účenie Stránok zo Sitemap

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

Pripravení povýšiť váš
používateľská skúsenosť?

Nasadzujte AI asistentov, ktorí potešia zákazníkov a rastú s vaším podnikaním.

V súlade s GDPR