Docusaurus

Szinkronizálja Docusaurus dokumentációs webhelyét az AI SmartTalk tudásbázisába. Az AI minden egyes oldalból tanulni fog a webhelytérképében—tökéletes támogatási botok számára, amelyek technikai kérdésekre válaszolnak.

---

Áttekintés

A Docusaurus integráció lehetővé teszi, hogy:

• Importálja az összes oldalt automatikusan a webhelytérképéből
• Tartsa szinkronban a dokumentációt a frissítések közzétételekor
• Válaszoljon kérdésekre a dokumentációjáról beszélgetés formájában
• Csökkentse a támogatási terhelést azzal, hogy az AI kezeli a gyakori kérdéseket

Érdekesség: Az AI SmartTalk saját dokumentációja Docusaurust használ, és ez az integráció működteti a támogatási chatbotunkat!

---

Előfeltételek

Mielőtt elkezdené, győződjön meg arról, hogy rendelkezik:

• Egy aktív AI SmartTalk fiókkal
• Egy Docusaurus webhellyel, amely érvényes sitemap.xml fájlt tartalmaz
• A webhelyének nyilvánosan hozzáférhetőnek kell lennie (vagy biztosítania kell a hitelesítést)

---

Lépésről lépésre történő beállítás

1. lépés: Keresse meg a Webhelytérképét

A Docusaurus automatikusan generál egy webhelytérképet. Ezt itt találja:

https://your-docs-site.com/sitemap.xml

Ellenőrizze, hogy betöltődik-e a böngészőjében, és tartalmazza a dokumentációs oldalait.

2. lépés: Adja hozzá a Docusaurus integrációt

1. Jelentkezzen be az AI SmartTalk fiókjába
2. Navigáljon a Beállítások → Integrációk menüpontra
3. Keresse meg a Docusaurus-t, és kattintson a Csatlakozás gombra
4. Adja meg a webhelytérkép URL-jét
5. Kattintson a Érvényesítés gombra

3. lépés: Importálási beállítások konfigurálása

Az érvényesítés után konfigurálja az importálást:

Beállítás	Leírás
Webhelytérkép URL	A teljes URL a sitemap.xml fájlhoz
Tartalmazási minták	Csak azokat az oldalakat szinkronizálja, amelyek megfelelnek a mintáknak (opcionális)
Kizárási minták	Hagyja figyelmen kívül a konkrét oldalakat vagy szakaszokat (opcionális)

4. lépés: Indítsa el az importálást

1. Kattintson az Oldalak importálása gombra
2. Az AI SmartTalk bejárja a webhelytérképében található URL-eket
3. A tartalom kinyerésre kerül és hozzáadódik a tudásbázisához
4. Várjon, amíg az importálás befejeződik (haladás megjelenítve)

5. lépés: Ellenőrizze az importálást

1. Menjen az Ismeretek szekcióra az AI SmartTalk-ban
2. A dokumentációs oldalainak meg kell jelennie
3. Tesztelje az AI-t, kérdéseket téve a dokumentációjáról

---

Mi kerül szinkronizálásra

Tartalom	Hogyan dolgozzák fel
Oldalcím	Dokumentum azonosítóként használva
Oldaltartalom	Teljes szöveg kinyerve a HTML-ből
Címek	Megőrzésre kerülnek a struktúra érdekében
Kódblokkok	Az eredeti formájukban kerülnek be
Táblázatok	Olvasható formátumra konvertálva
URL-ek	Az oldal URL-je tárolva van hivatkozásként

Tartalom kinyerése

Az AI SmartTalk a fő tartalmi területet vonja ki, és figyelmen kívül hagyja:

• Navigációs menüket
• Oldalsávokat
• Lábléceket
• Szkripteket és stílusokat

---

Szinkronizálási Viselkedés

Kézi Importálás

Kattintson a Importálás gombra az integrációs beállításokban a következőkhöz:

• A legfrissebb webhelytérkép lekérése
• Új oldalak hozzáadása
• Megváltozott oldalak frissítése
• Törölt oldalak eltávolítása

A Dokumentáció Frissen Tartása

A mindig aktuális dokumentációért:

1. Kézi frissítés: Kattintson az Importálás gombra a frissítések közzététele után
2. Ütemezett szinkronizálás: Használja a SmartFlow-t az importálások automatizálására

SmartFlow Ütemezett Importálás

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

---

URL Minták

Tartalmazza a Mintákat

Csak bizonyos szakaszokat szinkronizáljon:

Minta	Hatás
/docs/api/*	Csak az API dokumentáció
/docs/guides/*	Csak az útmutatók szakasz
/blog/*	Csak a blogbejegyzések

Kizárja a Mintákat

Hagyja ki a bizonyos oldalakat:

Minta	Hatás
/docs/internal/*	Hagyja ki a belső dokumentációt
/changelog	Hagyja ki a változásnapló oldalt
*/draft-*	Hagyja ki a vázlat oldalakat

---

Használati Esetek

Technikai Támogató Bot

Szinkronizálja a termék dokumentációját:

• "Hogyan telepíthetem az SDK-t?"
• "Mik az API sebességkorlátai?"
• "Mutasson egy példát a hitelesítésre"

Fejlesztői Dokumentáció

Szinkronizálja az API hivatkozásokat és útmutatókat:

• "Milyen paramétereket fogad el a /users végpont?"
• "Hogyan kezeljem a webhooks-t?"
• "Mi a különbség az v1 és v2 API között?"

Belső Tudásbázis

Szinkronizálja a vállalati wikit és eljárásokat:

• "Mi a folyamat a PTO kérésére?"
• "Hogyan állítsam be a fejlesztési környezetemet?"
• "Hol találom a márkairányelveket?"

---

Hibaelhárítás

Webhelytérkép Problémák

Probléma	Megoldás
"Érvénytelen webhelytérkép"	Ellenőrizze, hogy az URL érvényes XML-t ad vissza
"Nincsenek oldalak"	Ellenőrizze, hogy a webhelytérkép tartalmaz <url> bejegyzéseket
"Hozzáférés megtagadva"	Biztosítsa, hogy a webhelytérkép nyilvánosan hozzáférhető legyen

Importálási Problémák

Probléma	Megoldás
Oldalak hiányoznak	Ellenőrizze a tartalmazza/kizárja mintákat
Az importálás megakadt	Nagy webhelyek esetén időbe telik; várjon vagy importáljon csoportokban
Régi tartalom	Újraimportálás a legfrissebb verziók lekéréséhez

Tartalom Minősége

Probléma	Megoldás
Rossz tartalom került ki	Jelentse a problémát—lehet, hogy egyedi kinyerés szükséges
Hiányzó kódblokkok	Ellenőrizze, hogy a kód a szabványos <pre><code> tagekben van
Zavaros szöveg	Ellenőrizze az oldal kódolását (UTF-8 ajánlott)

---

Az Integráció Kezelése

Akció	Hogyan
Minden újraimportálása	Kattintson az Importálás gombra az integrációs beállításokban
Webhelytérkép módosítása	Frissítse az URL-t és importáljon újra
Tartalom eltávolítása	Húzza le az integrációt vagy törölje a Tudásból
Kapcsolat megszüntetése	Beállítások → Integrációk → Docusaurus → Kapcsolat megszüntetése

---

Legjobb Gyakorlatok

1. Minőségi tartalom: Jól megírt dokumentáció = jobb AI válaszok
2. Világos struktúra: Használjon címsorokat, listákat és táblázatokat
3. Leíró címek: Az oldalcímek segítik az AI-t a kontextus megértésében
4. Rendszeres szinkronizálás: Tartsa az AI-t naprakészen a legfrissebb dokumentációval
5. Alapos tesztelés: Tegyen fel gyakori kérdéseket az AI pontosságának ellenőrzésére

---

Docusaurus Konfigurációs Tippek

Optimalizálás AI Kinyeréshez

A docusaurus.config.js fájlban:

module.exports = {
  // Biztosítsa, hogy a webhelytérkép generálva legyen
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Használjon leíró oldalcímeket
  title: 'A Termék Dokumentációja',
  
  // Tartalmazzon metaadatokat
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentáció a Termékéhez'
    }],
  },
};

Oldalak Kizárása a Webhelytérképből

Bizonyos oldalak szinkronizálásának megakadályozásához:

// Az oldal frontmatterében
---
title: Belső Oldal
sitemap:
  exclude: true
---

---

Kapcsolódó Dokumentáció

• Integrációk Áttekintése
• Tudásbázis Kezelés
• RSS Hírcsatorna Integráció — Blog/hírek tartalomhoz
• SmartFlow Ütemezett Triggerek — Importok automatizálása