Docusaurus
Sinhronizujte svoju Docusaurus dokumentaciju u AI SmartTalk-ovu bazu znanja. Vaša AI će učiti iz svake stranice u vašem sitemapu—savršeno za botove za podršku koji odgovaraju na tehnička pitanja.
Pregled
Docusaurus integracija vam omogućava da:
- Uvezete sve stranice iz vašeg sitemap-a automatski
- Održavate dokumente sinhronizovanim kada objavite ažuriranja
- Odgovarate na pitanja o vašoj dokumentaciji konverzacionalno
- Smanjite opterećenje podrške tako što ćete omogućiti AI da se bavi uobičajenim pitanjima
Zanimljiva činjenica: Dokumentacija AI SmartTalk-a koristi Docusaurus, a ova integracija pokreće naš chatbot za podršku!
Preduslovi
Prije nego što počnete, osigurajte da imate:
- Aktivni AI SmartTalk nalog
- Docusaurus sajt sa važećim
sitemap.xml - Vaš sajt mora biti javno dostupan (ili obezbijediti autentifikaciju)
Postupak postavljanja
Korak 1: Pronađite svoj Sitemap
Docusaurus automatski generiše sitemap. Pronađite ga na:
https://your-docs-site.com/sitemap.xml
Provjerite da li se učitava u vašem pretraživaču i sadrži vaše stranice dokumentacije.
Korak 2: Dodajte Docusaurus integraciju
- Prijavite se na svoj AI SmartTalk nalog
- Idite na Podešavanja → Integracije
- Pronađite Docusaurus i kliknite na Poveži
- Unesite URL vašeg sitemap-a
- Kliknite na Validiraj
Korak 3: Konfigurišite postavke uvoza
Nakon validacije, konfigurišite svoj uvoz:
| Postavka | Opis |
|---|---|
| Sitemap URL | Potpuni URL do vašeg sitemap.xml |
| Uključite obrasce | Samo sinhronizujte stranice koje odgovaraju obrascima (opciono) |
| Isključite obrasce | Preskočite specifične stranice ili sekcije (opciono) |
Korak 4: Započnite uvoz
- Kliknite na Uvezi stranice
- AI SmartTalk pretražuje svaki URL u vašem sitemap-u
- Sadržaj se izvlači i dodaje u vašu bazu znanja
- Sačekajte da se uvoz završi (prikazan napredak)
Korak 5: Verifikujte uvoz
- Idite na Znanje u AI SmartTalk
- Vaše stranice dokumentacije trebaju se pojaviti
- Testirajte svoju AI postavljanjem pitanja o vašim dokumentima
Šta se sinhronizuje
| Sadržaj | Kako se obrađuje |
|---|---|
| Naslov stranice | Koristi se kao identifikator dokumenta |
| Sadržaj stranice | Potpuni tekst izvučen iz HTML-a |
| Naslovi | Očuvani za strukturu |
| Kod blokovi | Uključeni onakvi kakvi jesu |
| Tabele | Pretvorene u čitljiv format |
| URL-ovi | URL stranice pohranjen za referencu |
Ekstrakcija sadržaja
AI SmartTalk izvlači glavni sadržaj i ignorira:
- Navigacione menije
- Bočne trake
- Podnožja
- Skripte i stilove
Sync Behavior
Manual Import
Kliknite Import u postavkama integracije da biste:
- Preuzeli najnoviji sitemap
- Dodali nove stranice
- Ažurirali promijenjene stranice
- Uklonili obrisane stranice
Keeping Docs Fresh
Za uvijek aktuelnu dokumentaciju:
- Ručno osvježavanje: Kliknite Import nakon objavljivanja ažuriranja
- Zakazano sinhronizovanje: 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
Sinhronizujte samo određene sekcije:
| Pattern | Effect |
|---|---|
/docs/api/* | Samo API dokumentacija |
/docs/guides/* | Samo sekcija vodiča |
/blog/* | Samo blog postovi |
Exclude Patterns
Preskočite određene stranice:
| Pattern | Effect |
|---|---|
/docs/internal/* | Preskočite interne dokumente |
/changelog | Preskočite stranicu sa promjenama |
*/draft-* | Preskočite nacrte stranica |
Use Cases
Technical Support Bot
Sinhronizujte dokumentaciju vašeg proizvoda:
- "Kako da instaliram SDK?"
- "Koja su ograničenja API poziva?"
- "Pokažite mi primjer autentifikacije"
Developer Documentation
Sinhronizujte API reference i vodiče:
- "Koje parametre prihvata /users endpoint?"
- "Kako da obradim webhooks?"
- "Koja je razlika između v1 i v2 API?"
Internal Knowledge Base
Sinhronizujte kompanijske wikipedije i procedure:
- "Koji je proces za traženje PTO?"
- "Kako da postavim svoje razvojno okruženje?"
- "Gdje mogu pronaći smjernice brenda?"
Troubleshooting
Sitemap Issues
| Issue | Solution |
|---|---|
| "Invalid sitemap" | Provjerite da URL vraća validan XML |
| "No pages found" | Provjerite da sitemap sadrži <url> unose |
| "Access denied" | Osigurajte da je sitemap javno dostupan |
Import Issues
| Issue | Solution |
|---|---|
| Stranice nedostaju | Provjerite include/exclude obrasce |
| Uvoz zaglavljen | Veliki sajtovi zahtijevaju vrijeme; sačekajte ili uvezite u serijama |
| Stari sadržaj | Ponovo uvezite da biste preuzeli najnovije verzije |
Content Quality
| Issue | Solution |
|---|---|
| Pogrešan sadržaj izvučen | Prijavite problem—možda je potrebna prilagođena ekstrakcija |
| Nedostaju kod blokovi | Provjerite da je kod u standardnim <pre><code> tagovima |
| Izobličen tekst | Provjerite kodiranje stranice (preporučuje se UTF-8) |
Managing the Integration
| Action | How |
|---|---|
| Re-import all | Kliknite Import u postavkama integracije |
| Change sitemap | Ažurirajte URL i ponovo uvezite |
| Remove content | Isključite integraciju ili obrišite iz Znanja |
| Disconnect | Postavke → Integracije → Docusaurus → Isključite |
Najbolje Prakse
- Kvalitetan sadržaj: Dobro napisani dokumenti = bolji AI odgovori
- Jasna struktura: Koristite naslove, liste i tabele
- Opisni naslovi: Naslovi stranica pomažu AI-u da razume kontekst
- Redovne sinhronizacije: Održavajte AI ažuriranim sa najnovijom dokumentacijom
- Temeljno testiranje: Postavljajte uobičajena pitanja kako biste proverili tačnost AI-a
Docusaurus Savjeti za Konfiguraciju
Optimizujte za AI Ekstrakciju
U vašem docusaurus.config.js:
module.exports = {
// Osigurajte da se generiše 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 Sitemapa
Da biste sprečili da određene stranice budu sinhronizovane:
// U frontmatter stranice
---
title: Interna Stranica
sitemap:
exclude: true
---
Povezana Dokumentacija
- Pregled Integracija
- Upravljanje Bazom Znanja
- Integracija RSS Feeda — Za blog/novosti sadržaj
- SmartFlow Zakazani Okidači — Automatizujte uvoze