Sari la conținutul principal

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ți 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 susține 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.xml valid
  • 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 conține paginile de documentație.

Pasul 2: Adăugați Integrarea Docusaurus

  1. Conectați-vă la contul dvs. AI SmartTalk
  2. Navigați la SetăriIntegrări
  3. Găsiți Docusaurus și faceți clic pe Conectare
  4. Introduceți URL-ul hărții site-ului dvs.
  5. Faceți clic pe Validare

Pasul 3: Configurați Setările de Import

După validare, configurați importul:

SetareDescriere
URL Harta Site-uluiURL complet către sitemap.xml
Modele de includereSincronizați doar paginile care se potrivesc cu modelele (opțional)
Modele de excludereSăriți paginile sau secțiunile specifice (opțional)

Pasul 4: Începeți Importul

  1. Faceți clic pe Importați Pagini
  2. AI SmartTalk va explora fiecare URL din harta site-ului dvs.
  3. Conținutul este extras și adăugat în baza dvs. de cunoștințe
  4. Așteptați finalizarea importului (progresul va fi afișat)

Pasul 5: Verificați Importul

  1. Accesați Cunoștințe în AI SmartTalk
  2. Pagina dvs. de documentație ar trebui să apară
  3. Testați AI-ul dvs. punând întrebări despre documentele dvs.

Ce se Sincronizează

ConținutCum este Procesat
Titlul paginiiFolosit ca identificator al documentului
Conținutul paginiiTextul complet extras din HTML
TitluriPăstrate pentru structură
Blocuri de codIncluse așa cum sunt
TabeleConvertite într-un format lizibil
URL-uriURL-ul paginii stocat pentru referință

Extracția Conținutului

AI SmartTalk extrage zona principală de conținut și ignoră:

  • Meniuri de navigare
  • Bare laterale
  • Subsoluri
  • Scripturi și stiluri

Comportamentul de Sincronizare

Import Manual

Faceți clic pe Importați în setările integrării pentru a:

  • Obține harta site-ului cea mai recentă
  • Adăuga pagini noi
  • Actualiza paginile modificate
  • Îndepărta paginile șterse

Menținerea Documentelor Actualizate

Pentru documentație întotdeauna actualizată:

  1. Reîmprospătare manuală: Faceți clic pe Import după publicarea actualizărilor
  2. Sincronizare programată: Utilizați SmartFlow pentru a automatiza importurile

Import Programat SmartFlow

Workflow: Docusaurus Auto-Sync
Trigger: Programat (Zilnic la 3:00 AM)
Actions:
- Sync Connector:
Type: Docusaurus
Sitemap: https://docs.example.com/sitemap.xml

Modele URL

Modele de Includere

Sincronizați doar secțiuni specifice:

ModelEfect
/docs/api/*Numai documentația API
/docs/guides/*Numai secțiunea ghidurilor
/blog/*Numai postările de blog

Modele de Excludere

Săriți anumite pagini:

ModelEfect
/docs/internal/*Săriți documentele interne
/changelogSăriți pagina de modificări
*/draft-*Săriți paginile în draft

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ție pentru Dezvoltatori

Sincronizați referințele API și ghidurile:

  • "Ce parametri acceptă endpoint-ul /users?"
  • "Cum gestionez webhook-urile?"
  • "Care este diferența dintre API v1 și v2?"

Baza de Cunoștințe Interne

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 Site-ului

ProblemăSoluție
"Harta site-ului invalidă"Verificați că URL-ul returnează XML valid
"Nicio pagină găsită"Verificați că harta site-ului conține intrări <url>
"Acces interzis"Asigurați-vă că harta site-ului este accesibilă public

Probleme cu Importul

ProblemăSoluție
Pagini lipsăVerificați modelele de includere/excludere
Import blocatSite-urile mari necesită timp; așteptați sau importați în loturi
Conținut vechiRe-importați pentru a obține cele mai recente versiuni

Calitatea Conținutului

ProblemăSoluție
Conținut greșit extrasRaportați problema — poate necesita extracție personalizată
Blocuri de cod lipsăVerificați că codul este în etichetele standard <pre><code>
Text distorsionatVerificați codificarea paginii (UTF-8 recomandat)

Gestionarea Integrării

AcțiuneCum
Re-importați totFaceți clic pe Import în setările integrării
Schimbați harta site-uluiActualizați URL-ul și re-importați
Îndepărtați conținutulDeconectați integrarea sau ștergeți din Cunoștințe
DeconectațiSetări → Integrări → Docusaurus → Deconectare

Cele Mai Bune Practici

  1. Conținut de calitate: Documente bine scrise = răspunsuri mai bune de la AI
  2. Structură clară: Utilizați titluri, liste și tabele
  3. Titluri descriptive: Titlurile paginilor ajută AI-ul să înțeleagă contextul
  4. Sincronizări regulate: Mențineți AI-ul actualizat cu cea mai recentă documentație
  5. Testați temeinic: Puneți întrebări comune pentru a verifica acuratețea AI-ului

Sfaturi pentru Configurarea Docusaurus

Optimizați pentru Extracția AI

În fișierul dvs. docusaurus.config.js:

module.exports = {
// Asigurați-vă că harta site-ului este generată
plugins: ['@docusaurus/plugin-sitemap'],

// Utilizați titluri descriptive pentru pagini
title: 'Documentația Produsului Dvs.',

// Includeți metadate
themeConfig: {
metadata: [{
name: 'description',
content: 'Documentația pentru Produsul Dvs.'
}],
},
};

Excludeți Pagini din Harta Site-ului

Pentru a preveni sincronizarea anumitor pagini:

// În frontmatter-ul paginii
---
title: Pagina Internă
sitemap:
exclude: true
---

Documentație Asemănătoare

Pregătit să îmbunătățești
experiența utilizatorului?

Lansează asistenți AI care încântă clienții și se scalază odată cu afacerea ta.

Conform GDPR