Docusaurus

Szinkronizálja Docusaurus dokumentációs webhelyét az AI SmartTalk tudásbázisával. Az AI minden oldalt megtanul 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 terheket 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 róla, 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 elé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. 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: Konfigurálja az importálási beállításokat

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-hez
Tartalmazási minták	Csak a mintáknak megfelelő oldalakat szinkronizál (opcionális)
Kizárási minták	Kihagy bizonyos 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 (a haladás látható)

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

1. Lépjen az Ismeretek menüpontra az AI SmartTalk-ban
2. A dokumentációs oldalainak meg kell jelennie
3. Tesztelje az AI-t, kérdezzen 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őrizve a struktúra érdekében
Kódblokkok	Eredeti formájukban belefoglalva
Táblázatok	Olvasható formátumba konvertálva
URL-ek	Az oldal URL-je tárolva referenciaként

Tartalom kinyerés

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

• Navigációs menük
• Oldalsávok
• Láblécek
• Szkriptek és stílusok

---

Szinkronizálási viselkedés

Kézi importálás

Kattintson az Importálás gombra az integrációs beállításokban, hogy:

• Lekérje a legfrissebb webhelytérképet
• Új oldalakat adjon hozzá
• Frissítse a megváltozott oldalakat
• Eltávolítsa a törölt oldalakat

A dokumentációk frissen tartása

A mindig aktuális dokumentáció érdekében:

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

Tartalmazási minták

Csak meghatározott szakaszokat szinkronizáljon:

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

Kizárási minták

Kihagy bizonyos oldalakat:

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

---

Használati esetek

Technikai Támogatási 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 webhookokat?"
• "Mi a különbség a 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-e <url> bejegyzéseket
"Hozzáférés megtagadva"	Győződjön meg róla, hogy a webhelytérkép nyilvánosan elérhető

Importálási problémák

Probléma	Megoldás
Oldalak hiányoznak	Ellenőrizze a tartalmazási/kizárási mintákat
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 beszerzéséhez

Tartalom minősége

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

---

Az integráció kezelése

Akció	Hogyan
Újraimportálás mind	Kattintson az Importálás gombra az integrációs beállításokban
Webhelytérkép megváltoztatása	Frissítse az URL-t és újraimportáljon
Tartalom eltávolítása	Húzza le az integrációt vagy törölje a Tudásból
Kapcsolat bontása	Beállítások → Integrációk → Docusaurus → Kapcsolat bontása

---

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ímeket, 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 legújabb 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 az 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: 'Termék Dokumentáció',
  
  // 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ése
• RSS Feed integráció — Blog/hírek tartalomhoz
• SmartFlow ütemezett triggerjei — Importálások automatizálása