Docusaurus
Sincronizați site-ul dvs. de documentație Docusaurus în baza de cunoștințe AI SmartTalk. AI-ul dvs. va învăța din fiecare pagină din harta site-ului dvs. — perfect pentru boții de suport care răspund la întrebări tehnice.
Prezentare generală
Integrarea Docusaurus vă permite să:
- Importați toate paginile din harta site-ului dvs. automat
- Mențineți documentele sincronizate atunci când publicați actualizări
- Răspundeți la întrebări despre documentația dvs. într-un mod conversațional
- Reduceți sarcina de suport lăsând AI-ul să se ocupe de întrebările comune
Fapt amuzant: Documentația proprie a AI SmartTalk folosește Docusaurus, iar această integrare alimentează chatbot-ul nostru de suport!
Cerințe preliminare
Înainte de a începe, asigurați-vă că aveți:
- Un cont activ AI SmartTalk
- Un site Docusaurus cu un
sitemap.xmlvalid - Site-ul dvs. trebuie să fie accesibil public (sau să oferiți autentificare)
Configurare Pas cu Pas
Pasul 1: Localizați Harta Site-ului
Docusaurus generează automat o hartă a site-ului. O găsiți la:
https://your-docs-site.com/sitemap.xml
Verificați că se încarcă în browserul dvs. și că conține paginile de documentație.
Pasul 2: Adăugați Integrarea Docusaurus
- Conectați-vă la contul dvs. AI SmartTalk
- Navigați la Setări → Integrări
- Găsiți Docusaurus și faceți clic pe Conectare
- Introduceți URL-ul hărții site-ului dvs.
- Faceți clic pe Validare
Pasul 3: Configurați Setările de Import
După validare, configurați importul dvs.:
| Setare | Descriere |
|---|---|
| URL Harta Site-ului | URL complet către sitemap.xml |
| Modele incluse | Sincronizați doar paginile care se potrivesc cu modelele (opțional) |
| Modele excluse | Săriți paginile sau secțiunile specifice (opțional) |
Pasul 4: Începeți Importul
- Faceți clic pe Importați Pagini
- AI SmartTalk va explora fiecare URL din harta site-ului dvs.
- Conținutul este extras și adăugat în baza dvs. de cunoștințe
- Așteptați finalizarea importului (progresul va fi afișat)
Pasul 5: Verificați Importul
- Accesați Cunoștințe în AI SmartTalk
- Pagina dvs. de documentație ar trebui să apară
- Testați AI-ul dvs. punând întrebări despre documentele dvs.
Ce se Sincronizează
| Conținut | Cum este Procesat |
|---|---|
| Titlul paginii | Folosit ca identificator al documentului |
| Conținutul paginii | Textul complet extras din HTML |
| Titluri | Păstrate pentru structură |
| Blocuri de cod | Incluse așa cum sunt |
| Tabele | Convertite într-un format lizibil |
| URL-uri | URL-ul paginii stocat pentru referință |
Extracția Conținutului
AI SmartTalk extrage zona principală de conținut și ignoră:
- Meniurile de navigare
- Barele laterale
- Subsolurile
- Scripturile și stilurile
Comportamentul de Sincronizare
Import Manual
Faceți clic pe Import în setările de integrare pentru a:
- Obține harta de site actualizată
- Adăuga pagini noi
- Actualiza paginile modificate
- Îndepărta paginile șterse
Menținerea Documentației Actualizate
Pentru o documentație întotdeauna actualizată:
- Refresh manual: Faceți clic pe Import după publicarea actualizărilor
- Sincronizare programată: Utilizați SmartFlow pentru a automatiza importurile
Import Programat SmartFlow
Workflow: Docusaurus Auto-Sync
Trigger: Scheduled (Daily at 3:00 AM)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml
Tipare URL
Tipare Incluse
Sincronizați doar secțiuni specifice:
| Tipar | Efect |
|---|---|
/docs/api/* | Doar documentația API |
/docs/guides/* | Doar secțiunea de ghiduri |
/blog/* | Doar postările de blog |
Tipare Excluse
Săriți anumite pagini:
| Tipar | Efect |
|---|---|
/docs/internal/* | Săriți documentele interne |
/changelog | Săriți pagina de changelog |
*/draft-* | Săriți paginile de proiect |
Cazuri de Utilizare
Bot de Suport Tehnic
Sincronizați documentația produsului dvs.:
- "Cum instalez SDK-ul?"
- "Care sunt limitele de rată ale API-ului?"
- "Arată-mi un exemplu de autentificare"
Documentația pentru Dezvoltatori
Sincronizați referințele și ghidurile API:
- "Ce parametri acceptă endpoint-ul /users?"
- "Cum gestionez webhook-urile?"
- "Care este diferența dintre API v1 și v2?"
Baza de Cunoștințe Internă
Sincronizați wiki-urile și procedurile companiei:
- "Care este procesul pentru solicitarea PTO?"
- "Cum îmi configurez mediul de dezvoltare?"
- "Unde găsesc liniile directoare ale brandului?"
Depanare
Probleme cu Harta de Site
| Problemă | Soluție |
|---|---|
| "Harta de site invalidă" | Verificați dacă URL-ul returnează XML valid |
| "Nicio pagină găsită" | Verificați dacă harta de site conține intrări <url> |
| "Acces refuzat" | Asigurați-vă că harta de site este accesibilă public |
Probleme cu Importul
| Problemă | Soluție |
|---|---|
| Pagini lipsă | Verificați tiparele incluse/excluse |
| Import blocat | Site-urile mari durează; așteptați sau importați în loturi |
| Conținut vechi | Re-importați pentru a obține cele mai recente versiuni |
Calitatea Conținutului
| Problemă | Soluție |
|---|---|
| Conținut greșit extras | Raportați problema—poate necesita extragere personalizată |
| Blocuri de cod lipsă | Verificați dacă codul este în etichetele standard <pre><code> |
| Text distorsionat | Verificați codificarea paginii (UTF-8 recomandat) |
Gestionarea Integrării
| Acțiune | Cum |
|---|---|
| Re-importați tot | Faceți clic pe Import în setările de integrare |
| Schimbați harta de site | Actualizați URL-ul și re-importați |
| Îndepărtați conținutul | Deconectați integrarea sau ștergeți din Cunoștințe |
| Deconectați | Setări → Integrări → Docusaurus → Deconectare |
Cele Mai Bune Practici
- Conținut de calitate: Documentație bine scrisă = răspunsuri mai bune de la AI
- Structură clară: Folosiți titluri, liste și tabele
- Titluri descriptive: Titlurile paginilor ajută AI să înțeleagă contextul
- Sincronizări regulate: Mențineți AI actualizat cu cea mai recentă documentație
- Testați temeinic: Puneți întrebări frecvente pentru a verifica acuratețea AI
Sfaturi de Configurare Docusaurus
Optimizează pentru Extracția AI
În fișierul dumneavoastră docusaurus.config.js:
module.exports = {
// Asigurați-vă că sitemap-ul este generat
plugins: ['@docusaurus/plugin-sitemap'],
// Folosiți titluri descriptive pentru pagini
title: 'Documentația Produsului Dumneavoastră',
// Includeți metadate
themeConfig: {
metadata: [{
name: 'description',
content: 'Documentație pentru Produsul Dumneavoastră'
}],
},
};
Excludeți Pagini din Sitemap
Pentru a preveni sincronizarea anumitor pagini:
// În frontmatter-ul paginii
---
title: Pagina Internă
sitemap:
exclude: true
---