Preskoči na glavni sadržaj

Docusaurus

Sinkronizirajte svoju Docusaurus dokumentacijsku stranicu s bazom znanja AI SmartTalk-a. Vaš AI će učiti iz svake stranice u vašem mapi stranica—savršeno za podršku botovima koji odgovaraju na tehnička pitanja.


Pregled

Docusaurus integracija omogućuje vam:

  • Uvoz svih stranica iz vaše mape stranica automatski
  • Održavanje dokumenata sinkroniziranim kada objavljujete ažuriranja
  • Odgovaranje na pitanja o vašoj dokumentaciji konverzacijom
  • Smanjenje opterećenja podrške dopuštajući AI-u da se bavi uobičajenim pitanjima

Zanimljiva činjenica: Dokumentacija AI SmartTalk-a koristi Docusaurus, a ova integracija pokreće naš chatbot za podršku!


Preduvjeti

Prije nego što započnete, osigurajte da imate:

  • Aktivni AI SmartTalk račun
  • Docusaurus stranicu s važećim sitemap.xml
  • Vaša stranica mora biti javno dostupna (ili osigurati autentifikaciju)

Korak-po-korak postavljanje

Korak 1: Pronađite svoju mapu stranica

Docusaurus automatski generira mapu stranica. Pronađite je na:

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

Provjerite učitava li se u vašem pregledniku i sadrži li vaše dokumentacijske stranice.

Korak 2: Dodajte Docusaurus integraciju

  1. Prijavite se na svoj AI SmartTalk račun
  2. Idite na PostavkeIntegracije
  3. Pronađite Docusaurus i kliknite Poveži
  4. Unesite URL svoje mape stranica
  5. Kliknite Potvrdi

Korak 3: Konfigurirajte postavke uvoza

Nakon potvrde, konfigurirajte svoj uvoz:

PostavkaOpis
URL mape stranicaPotpuni URL do vašeg sitemap.xml
Uključite obrasceSamo sinkronizirajte stranice koje odgovaraju obrascima (opcionalno)
Isključite obrascePreskočite određene stranice ili odjeljke (opcionalno)

Korak 4: Započnite uvoz

  1. Kliknite Uvezi stranice
  2. AI SmartTalk pretražuje svaki URL u vašoj mapi stranica
  3. Sadržaj se izvlači i dodaje u vašu bazu znanja
  4. Pričekajte da se uvoz završi (napredak će biti prikazan)

Korak 5: Provjerite uvoz

  1. Idite na Znanje u AI SmartTalk
  2. Vaše dokumentacijske stranice trebale bi se pojaviti
  3. Testirajte svoj AI postavljanjem pitanja o vašim dokumentima

Što se sinkronizira

SadržajKako se obrađuje
Naslov straniceKoristi se kao identifikator dokumenta
Sadržaj straniceCijeli tekst izvučen iz HTML-a
NasloviOčuvani za strukturu
Blokovi kodaUključeni onakvi kakvi jesu
TablicePretvorene u čitljiv format
URL-oviURL stranice pohranjen za referencu

Izvlačenje sadržaja

AI SmartTalk izvlači glavni sadržaj i ignorira:

  • Navigacijske izbornike
  • Bočne trake
  • Podnožja
  • Skripte i stilove

Sync Behavior

Manual Import

Kliknite Import u postavkama integracije kako biste:

  • Preuzeli najnoviju kartu stranica
  • Dodali nove stranice
  • Ažurirali promijenjene stranice
  • Uklonili izbrisane stranice

Keeping Docs Fresh

Za uvijek ažurnu dokumentaciju:

  1. Ručno osvježavanje: Kliknite Import nakon objavljivanja ažuriranja
  2. Zakazano sinkroniziranje: Koristite SmartFlow za automatizaciju uvoza

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

Sinkronizirajte samo određene sekcije:

PatternEffect
/docs/api/*Samo API dokumentacija
/docs/guides/*Samo sekcija vodiča
/blog/*Samo blog postovi

Exclude Patterns

Preskočite određene stranice:

PatternEffect
/docs/internal/*Preskočite interne dokumente
/changelogPreskočite stranicu s promjenama
*/draft-*Preskočite nacrte stranica

Use Cases

Technical Support Bot

Sinkronizirajte dokumentaciju vašeg proizvoda:

  • "Kako instalirati SDK?"
  • "Koja su ograničenja API poziva?"
  • "Pokažite mi primjer autentifikacije"

Developer Documentation

Sinkronizirajte API reference i vodiče:

  • "Koje parametre prihvaća /users endpoint?"
  • "Kako obraditi webhooks?"
  • "Koja je razlika između v1 i v2 API?"

Internal Knowledge Base

Sinkronizirajte tvrtkine wikipedije i procedure:

  • "Koji je postupak za traženje PTO-a?"
  • "Kako postaviti svoje razvojno okruženje?"
  • "Gdje mogu pronaći smjernice o brendu?"

Troubleshooting

Sitemap Issues

IssueSolution
"Invalid sitemap"Provjerite da URL vraća valjani XML
"No pages found"Provjerite sadrži li karta stranica <url> unose
"Access denied"Osigurajte da je karta stranica javno dostupna

Import Issues

IssueSolution
Pages missingProvjerite uključene/isključene obrasce
Import stuckVelike stranice trebaju vrijeme; pričekajte ili uvezite u serijama
Old contentPonovno uvezite kako biste preuzeli najnovije verzije

Content Quality

IssueSolution
Wrong content extractedPrijavite problem—možda je potrebna prilagođena ekstrakcija
Missing code blocksProvjerite je li kod u standardnim <pre><code> oznakama
Garbled textProvjerite kodiranje stranice (preporučuje se UTF-8)

Managing the Integration

ActionHow
Re-import allKliknite Import u postavkama integracije
Change sitemapAžurirajte URL i ponovno uvezite
Remove contentPrekinite integraciju ili izbrišite iz Znanja
DisconnectPostavke → Integracije → Docusaurus → Prekini vezu

Najbolje Prakse

  1. Kvalitetan sadržaj: Dobro napisani dokumenti = bolji AI odgovori
  2. Jasna struktura: Koristite naslove, popise i tablice
  3. Opisni naslovi: Naslovi stranica pomažu AI-u da razumije kontekst
  4. Redovite sinkronizacije: Držite AI ažuriranim s najnovijom dokumentacijom
  5. Temeljito testiranje: Postavljajte uobičajena pitanja kako biste provjerili točnost AI-a

Docusaurus Savjeti za Konfiguraciju

Optimizirajte za AI Ekstrakciju

U vašem docusaurus.config.js:

module.exports = {
// Osigurajte da se generira sitemap
plugins: ['@docusaurus/plugin-sitemap'],

// Koristite opisne naslove stranica
title: 'Dokumentacija za Vaš Proizvod',

// Uključite metapodatke
themeConfig: {
metadata: [{
name: 'description',
content: 'Dokumentacija za Vaš Proizvod'
}],
},
};

Isključite Stranice iz Sitemap-a

Da biste spriječili da se određene stranice sinkroniziraju:

// U frontmatter stranice
---
title: Interna Stranica
sitemap:
exclude: true
---

Povezana Dokumentacija

Spremni za unapređenje
korisničkog iskustva?

Implementirajte AI asistente koji oduševljavaju kupce i rastu s vašim poslovanjem.

U skladu s GDPR-om