Docusaurus
Sinkronizirajte svoju Docusaurus dokumentacijsku stranicu u AI SmartTalk-ovu bazu znanja. 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 sinkronizacije dokumenata kada objavite ažuriranja
- Odgovaranje na pitanja o vašoj dokumentaciji konverzacijom
- Smanjenje opterećenja podrške dopuštanjem 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 da se učitava u vašem pregledniku i da sadrži vaše dokumentacijske stranice.
Korak 2: Dodajte Docusaurus integraciju
- Prijavite se na svoj AI SmartTalk račun
- Idite na Postavke → Integracije
- Pronađite Docusaurus i kliknite Poveži
- Unesite URL svoje mape stranica
- Kliknite Potvrdi
Korak 3: Konfigurirajte postavke uvoza
Nakon potvrde, konfigurirajte svoj uvoz:
| Postavka | Opis |
|---|---|
| URL mape stranica | Potpuni URL do vašeg sitemap.xml |
| Uključite obrasce | Samo sinkronizirajte stranice koje odgovaraju obrascima (opcionalno) |
| Isključite obrasce | Preskočite određene stranice ili odjeljke (opcionalno) |
Korak 4: Započnite uvoz
- Kliknite Uvezi stranice
- AI SmartTalk pretražuje svaki URL u vašoj mapi stranica
- Sadržaj se izvlači i dodaje u vašu bazu znanja
- Pričekajte da se uvoz završi (napredak prikazan)
Korak 5: Provjerite uvoz
- Idite na Znanje u AI SmartTalk
- Vaše dokumentacijske stranice trebale bi se pojaviti
- Testirajte svoj AI postavljanjem pitanja o vašim dokumentima
Što se sinkronizira
| Sadržaj | Kako se obrađuje |
|---|---|
| Naslov stranice | Koristi se kao identifikator dokumenta |
| Sadržaj stranice | Cijeli tekst izvučen iz HTML-a |
| Naslovi | Očuvani za strukturu |
| Blokovi koda | Uključeni onakvi kakvi jesu |
| Tablice | Pretvorene u čitljiv format |
| URL-ovi | URL stranice pohranjen za referencu |
Izvlačenje sadržaja
AI SmartTalk izvlači glavno područje sadržaja i ignorira:
- Navigacijske izbornike
- Bočne trake
- Podnožja
- Skripte i stilove
Ponašanje sinkronizacije
Ručni uvoz
Kliknite Uvezi u postavkama integracije za:
- Dohvaćanje najnovije mape stranica
- Dodavanje novih stranica
- Ažuriranje promijenjenih stranica
- Uklanjanje izbrisanih stranica
Održavanje dokumenata ažurnima
Za uvijek aktualnu dokumentaciju:
- Ručno osvježavanje: Kliknite Uvezi nakon objavljivanja ažuriranja
- Zakazano sinkroniziranje: Koristite SmartFlow za automatizaciju uvoza
SmartFlow zakazani uvoz
Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml
Obrasci URL-a
Uključite obrasce
Samo sinkronizirajte određene odjeljke:
| Obrazac | Učinak |
|---|---|
/docs/api/* | Samo API dokumentacija |
/docs/guides/* | Samo odjeljak s vodičima |
/blog/* | Samo blog postovi |
Isključite obrasce
Preskočite određene stranice:
| Obrazac | Učinak |
|---|---|
/docs/internal/* | Preskočite interne dokumente |
/changelog | Preskočite stranicu s promjenama |
*/draft-* | Preskočite nacrte stranica |
Upotrebe
Bot za tehničku podršku
Sinkronizirajte svoju dokumentaciju proizvoda:
- "Kako instalirati SDK?"
- "Koja su ograničenja API poziva?"
- "Pokaži mi primjer autentifikacije"
Dokumentacija za programere
Sinkronizirajte API reference i vodiče:
- "Koje parametre prihvaća /users endpoint?"
- "Kako obraditi webhookove?"
- "Koja je razlika između v1 i v2 API-ja?"
Interna baza znanja
Sinkronizirajte tvrtkine wikipedije i procedure:
- "Koji je postupak za traženje PTO-a?"
- "Kako postaviti svoje razvojno okruženje?"
- "Gdje mogu pronaći smjernice za brend?"
Rješavanje problema
Problemi s mapom stranica
| Problem | Rješenje |
|---|---|
| "Nevažeća mapa stranica" | Provjerite da URL vraća važeći XML |
| "Nema pronađenih stranica" | Provjerite da mapa stranica sadrži <url> unose |
| "Pristup odbijen" | Osigurajte da je mapa stranica javno dostupna |
Problemi s uvozom
| Problem | Rješenje |
|---|---|
| Nedostaju stranice | Provjerite obrasce uključivanja/isključivanja |
| Uvoz se zaglavio | Velike stranice trebaju vrijeme; pričekajte ili uvezite u serijama |
| Stari sadržaj | Ponovno uvezite da biste dohvatili najnovije verzije |
Kvaliteta sadržaja
| Problem | Rješenje |
|---|---|
| Pogrešan sadržaj izvučen | Prijavite problem—možda je potrebna prilagođena ekstrakcija |
| Nedostaju blokovi koda | Provjerite je li kod u standardnim <pre><code> oznakama |
| Izobličen tekst | Provjerite kodiranje stranice (preporučuje se UTF-8) |
Upravljanje integracijom
| Akcija | Kako |
|---|---|
| Ponovno uvezite sve | Kliknite Uvezi u postavkama integracije |
| Promijenite mapu stranica | Ažurirajte URL i ponovno uvezite |
| Uklonite sadržaj | Prekinite integraciju ili izbrišite iz Znanja |
| Prekinite vezu | Postavke → Integracije → Docusaurus → Prekini vezu |
Najbolje prakse
- Kvalitetan sadržaj: Dobro napisani dokumenti = bolji odgovori AI-a
- Jasna struktura: Koristite naslove, popise i tablice
- Opisni naslovi: Naslovi stranica pomažu AI-u razumjeti kontekst
- Redovite sinkronizacije: Održavajte AI ažuriranim s najnovijom dokumentacijom
- Temeljito testiranje: Postavljajte uobičajena pitanja kako biste provjerili točnost AI-a
Docusaurus savjeti za konfiguraciju
Optimizirajte za ekstrakciju AI-a
U vašem docusaurus.config.js:
module.exports = {
// Osigurajte da se mapa stranica generira
plugins: ['@docusaurus/plugin-sitemap'],
// Koristite opisne naslove stranica
title: 'Dokumentacija vašeg proizvoda',
// Uključite metapodatke
themeConfig: {
metadata: [{
name: 'description',
content: 'Dokumentacija za vaš proizvod'
}],
},
};
Isključite stranice iz mape stranica
Da biste spriječili sinkronizaciju određenih stranica:
// U frontmatter stranice
---
title: Interna stranica
sitemap:
exclude: true
---
Povezana dokumentacija
- Pregled integracija
- Upravljanje bazom znanja
- Integracija RSS feed-a — Za blog/novi sadržaj
- SmartFlow zakazani okidači — Automatizirajte uvoze