Docusaurus
Sinhronizirajte svojo Docusaurus dokumentacijsko stran v bazo znanja AI SmartTalk. Vaša AI se bo učila iz vsake strani v vašem zemljevidu spletnih strani—popolno za podporne robote, ki odgovarjajo na tehnična vprašanja.
Pregled
Integracija Docusaurus vam omogoča:
- Uvoz vseh strani iz vašega zemljevida spletnih strani samodejno
- Ohranjanje sinhronizacije dokumentov ob objavi posodobitev
- Odgovarjanje na vprašanja o vaši dokumentaciji v pogovornem slogu
- Zmanjšanje obremenitve podpore z omogočanjem AI, da obravnava pogosta vprašanja
Zanimiva dejstva: Dokumentacija AI SmartTalk uporablja Docusaurus, ta integracija pa poganja naš podporni klepetalnik!
Predpogoji
Preden začnete, se prepričajte, da imate:
- Aktivno AI SmartTalk račun
- Docusaurus stran z veljavnim
sitemap.xml - Vaša stran mora biti javno dostopna (ali zagotoviti avtentikacijo)
Korak za korakom nastavitev
Korak 1: Najdite svoj zemljevid spletnih strani
Docusaurus samodejno generira zemljevid spletnih strani. Najdete ga na:
https://your-docs-site.com/sitemap.xml
Preverite, ali se naloži v vašem brskalniku in vsebuje vaše dokumentacijske strani.
Korak 2: Dodajte integracijo Docusaurus
- Prijavite se v svoj AI SmartTalk račun
- Pojdite na Nastavitve → Integracije
- Poiščite Docusaurus in kliknite Poveži
- Vnesite URL vašega zemljevida spletnih strani
- Kliknite Potrdi
Korak 3: Konfigurirajte nastavitve uvoza
Po potrditvi konfigurirajte svoj uvoz:
| Nastavitev | Opis |
|---|---|
| URL zemljevida spletnih strani | Poln URL do vašega sitemap.xml |
| Vključite vzorce | Sinhronizirajte le strani, ki ustrezajo vzorcem (neobvezno) |
| Izključite vzorce | Preskočite določene strani ali odseke (neobvezno) |
Korak 4: Začnite uvoz
- Kliknite Uvozi strani
- AI SmartTalk preišče vsak URL v vašem zemljevidu spletnih strani
- Vsebina se izloči in doda vaši bazi znanja
- Počakajte, da se uvoz zaključi (napredek prikazan)
Korak 5: Preverite uvoz
- Pojdite na Znanje v AI SmartTalk
- Vaše dokumentacijske strani bi se morale prikazati
- Preizkusite svojo AI tako, da postavite vprašanja o vaših dokumentih
Kaj se sinhronizira
| Vsebina | Kako se obdeluje |
|---|---|
| Naslov strani | Uporablja se kot identifikator dokumenta |
| Vsebina strani | Celotno besedilo, izločeno iz HTML |
| Naslovi | Ohranjeni za strukturo |
| Kodni bloki | Vključeni takšni, kot so |
| Tabele | Pretvorjene v berljiv format |
| URL-ji | URL strani shranjen za referenco |
Izločanje vsebine
AI SmartTalk izloča glavno območje vsebine in ignorira:
- Navigacijske menije
- Stranske vrstice
- Noge
- Skripte in sloge
Obnašanje sinhronizacije
Ročni uvoz
Kliknite Uvozi v nastavitvah integracije, da:
- Pridobite najnovejši zemljevid strani
- Dodate nove strani
- Posodobite spremenjene strani
- Odstranite izbrisane strani
Ohranitev dokumentov svežih
Za vedno aktualno dokumentacijo:
- Ročno osveževanje: Kliknite Uvozi po objavi posodobitev
- Načrtovana sinhronizacija: Uporabite SmartFlow za avtomatizacijo uvozov
Načrtovan uvoz SmartFlow
Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml
URL vzorci
Vključite vzorce
Sinhronizirajte samo določene odseke:
| Vzorec | Učinek |
|---|---|
/docs/api/* | Samo dokumentacija API |
/docs/guides/* | Samo odsek vodnikov |
/blog/* | Samo objave na blogu |
Izključite vzorce
Preskočite določene strani:
| Vzorec | Učinek |
|---|---|
/docs/internal/* | Preskočite notranje dokumente |
/changelog | Preskočite stran s spremembami |
*/draft-* | Preskočite osnutke strani |
Uporabniški primeri
Tehnična podpora
Sinhronizirajte dokumentacijo vašega izdelka:
- "Kako namestim SDK?"
- "Kakšne so omejitve API?"
- "Pokažite mi primer avtentikacije"
Dokumentacija za razvijalce
Sinhronizirajte API reference in vodnike:
- "Katere parametre sprejema končna točka /users?"
- "Kako obvladujem webhooke?"
- "Kakšna je razlika med API v1 in v2?"
Notranja baza znanja
Sinhronizirajte podjetniške wike in postopke:
- "Kakšen je postopek za zahtevo za dopust?"
- "Kako nastavim svoje razvojno okolje?"
- "Kje najdem smernice za blagovno znamko?"
Odpravljanje težav
Težave z zemljevidom strani
| Težava | Rešitev |
|---|---|
| "Neveljaven zemljevid strani" | Preverite, ali URL vrne veljaven XML |
| "Nobene strani niso bile najdene" | Preverite, ali zemljevid strani vsebuje <url> vnose |
| "Dostop zavrnjen" | Poskrbite, da je zemljevid strani javno dostopen |
Težave z uvozom
| Težava | Rešitev |
|---|---|
| Manjkajoče strani | Preverite vključitvene/izključitvene vzorce |
| Uvoz se je ustavil | Velike strani potrebujejo čas; počakajte ali uvozite v serijah |
| Stara vsebina | Ponovno uvozite, da pridobite najnovejše različice |
Kakovost vsebine
| Težava | Rešitev |
|---|---|
| Napačna vsebina je bila pridobljena | Poročajte o težavi—morda bo potrebna prilagojena ekstrakcija |
| Manjkajoči kodni bloki | Preverite, ali je koda v standardnih <pre><code> oznakah |
| Zmešana besedila | Preverite kodiranje strani (priporočeno UTF-8) |
Upravljanje integracije
| Dejanje | Kako |
|---|---|
| Ponovno uvozi vse | Kliknite Uvozi v nastavitvah integracije |
| Spremeni zemljevid strani | Posodobite URL in ponovno uvozite |
| Odstrani vsebino | Prekinite integracijo ali izbrišite iz znanja |
| Prekini povezavo | Nastavitve → Integracije → Docusaurus → Prekini povezavo |
Najboljše prakse
- Kakovostna vsebina: Dobro napisani dokumenti = boljši odgovori AI
- Jasna struktura: Uporabite naslove, sezname in tabele
- Opisni naslovi: Naslovi strani pomagajo AI razumeti kontekst
- Redno usklajevanje: Ohranite AI posodobljenega z najnovejšo dokumentacijo
- Temeljito testiranje: Postavite pogosta vprašanja za preverjanje natančnosti AI
Nasveti za konfiguracijo Docusaurusa
Optimizacija za ekstrakcijo AI
V vašem docusaurus.config.js:
module.exports = {
// Ensure sitemap is generated
plugins: ['@docusaurus/plugin-sitemap'],
// Use descriptive page titles
title: 'Your Product Docs',
// Include metadata
themeConfig: {
metadata: [{
name: 'description',
content: 'Documentation for Your Product'
}],
},
};
Izključitev strani iz zemljevida spletnih strani
Da preprečite, da bi bile nekatere strani sinhronizirane:
// In page frontmatter
---
title: Internal Page
sitemap:
exclude: true
---
Sorodna dokumentacija
- Pregled integracij
- Upravljanje znanja
- Integracija RSS vira — Za vsebino bloga/novic
- Načrtovani sprožilci SmartFlow — Avtomatizirajte uvoze