Docusaurus

Szinkronizálja Docusaurus dokumentációs webhelyét az AI SmartTalk tudásbázisába. Az AI minden egyes oldalból tanul 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 automatikusan az összes oldalt 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 terhet 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. Keresse meg itt:

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
Inklúziós 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 megjelenik)

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é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ő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 hivatkozásként

Tartalom kinyerése

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 Magatartás

Manuális Importálás

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

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

Dokumentumok Frissen Tartása

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

1. Manuális 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

Beillesztési Minták

Csak bizonyos 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

Hagyja ki a bizonyos oldalakat:

Minta	Hatás
/docs/internal/*	Hagyja ki a belső dokumentációt
/changelog	Hagyja ki a változásnaplót
*/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átok?"
• "Mutasson egy példát az azonosításra"

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éhez?"
• "Hogyan állítsam be a fejlesztési környezetemet?"
• "Hol találom a márkairányelveket?"

---

Hibaelhárítás

Sitemap Problémák

Probléma	Megoldás
"Érvénytelen sitemap"	Ellenőrizze, hogy az URL érvényes XML-t ad vissza
"Nincs találat"	Ellenőrizze, hogy a sitemap tartalmaz <url> bejegyzéseket
"Hozzáférés megtagadva"	Győződjön meg arról, hogy a sitemap nyilvánosan hozzáférhető

Importálási Problémák

Probléma	Megoldás
Oldalak hiányoznak	Ellenőrizze a beillesztési/kizárási mintákat
Importálás megakadt	Nagy oldalak 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 kiemelésre	Jelentse a problémát—lehet, hogy egyedi kiemelés szükséges
Hiányzó kódblokkok	Ellenőrizze, hogy a kód standard <pre><code> tagekben van
Zavaros szöveg	Ellenőrizze az oldal kódolását (UTF-8 ajánlott)

---

Az Integráció Kezelése

Tevékenység	Hogyan
Minden újraimportálása	Kattintson az Importálás gombra az integrációs beállításokban
Sitemap megváltoztatá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ó az Ön 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 Feed Integráció — Blog/hírek tartalomhoz
• SmartFlow Ütemezett Trigger-ek — Importok automatizálása