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
- Prihláste sa do svojho účtu AI SmartTalk
- Prejdite na Nastavenia → Integrácie
- Nájdite Docusaurus a kliknite na Pripojiť
- Zadajte URL svojej mapy stránok
- Kliknite na Overiť
Krok 3: Konfigurujte nastavenia importu
Po overení nakonfigurujte svoj import:
| Nastavenie | Popis |
|---|---|
| URL mapy stránok | Úplná URL adresa 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
- Kliknite na Importovať stránky
- AI SmartTalk prehľadáva každú URL vo vašej mape stránok
- Obsah je extrahovaný a pridaný do vašej znalostnej bázy
- Počkajte na dokončenie importu (pokrok je zobrazený)
Krok 5: Overte import
- Prejdite na Znalosti v AI SmartTalk
- Vaše dokumentačné stránky by sa mali zobraziť
- Otestujte svoj 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
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:
- Manuálne obnovenie: Kliknite na Import po publikovaní aktualizácií
- 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:
| Pattern | Effect |
|---|---|
/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:
| Pattern | Effect |
|---|---|
/docs/internal/* | Preskočiť interné dokumenty |
/changelog | Preskoč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
| Issue | Solution |
|---|---|
| "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
| Issue | Solution |
|---|---|
| Pages missing | Skontrolujte vzory zahrnutia/vylúčenia |
| Import stuck | Veľké stránky trvajú dlhšie; počkajte alebo importujte po dávkach |
| Old content | Znovu importujte, aby ste načítali najnovšie verzie |
Content Quality
| Issue | Solution |
|---|---|
| Wrong content extracted | Nahláste problém—môže byť potrebná vlastná extrakcia |
| Missing code blocks | Overte, či je kód v štandardných <pre><code> značkách |
| Garbled text | Skontrolujte k ódovanie stránky (odporúča sa UTF-8) |
Managing the Integration
| Action | How |
|---|---|
| Re-import all | Kliknite na Import v nastaveniach integrácie |
| Change sitemap | Aktualizujte URL a znovu importujte |
| Remove content | Odpojte integráciu alebo vymažte z Knowledge |
| Disconnect | Nastavenia → Integrácie → Docusaurus → Odpojiť |
Najlepšie Praktiky
- Kvalitný obsah: Dobre napísaná dokumentácia = lepšie odpovede AI
- Jasná štruktúra: Používajte nadpisy, zoznamy a tabuľky
- Popisné názvy: Názvy stránok pomáhajú AI pochopiť kontext
- Pravidelné synchronizácie: Udržujte AI aktualizovanú s najnovšou dokumentáciou
- 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
- Prehľad Integrácií
- Správa Znalostnej Základy
- Integrácia RSS Feedu — Pre obsah blogu/noviniek
- Naplánované Spúšťače SmartFlow — Automatizujte importy