Docusaurus

Sinkronizoni faqen tuaj të dokumentacionit Docusaurus në bazën e njohurive të AI SmartTalk. AI juaj do të mësojë nga çdo faqe në hartën tuaj të faqes—e përsosur për botët e mbështetjes që përgjigjen në pyetje teknike.

---

Përmbledhje

Integrimi i Docusaurus ju mundëson të:

• Importoni të gjitha faqet nga harta juaj e faqes automatikisht
• Mbani dokumentet të sinkronizuara kur publikoni përditësime
• Përgjigjeni në pyetje rreth dokumentacionit tuaj në mënyrë konversacionale
• Reduktoni ngarkesën e mbështetjes duke lejuar AI të trajtojë pyetje të zakonshme

Fakt interesant: Dokumentacioni i AI SmartTalk përdor Docusaurus, dhe ky integrim fuqizon chatbot-in tonë të mbështetjes!

---

Kërkesat e Parapara

Para se të filloni, sigurohuni që keni:

• Një llogari aktive në AI SmartTalk
• Një faqe Docusaurus me një sitemap.xml të vlefshme
• Faqja juaj duhet të jetë e aksesueshme publikisht (ose ofroni autentifikim)

---

Hapat për Konfigurimin

Hapi 1: Gjeni Hartën e Faqeve

Docusaurus automatikisht gjeneron një hartë faqesh. Gjeni atë në:

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

Verifikoni që ngarkohet në shfletuesin tuaj dhe përmban faqet e dokumentacionit tuaj.

Hapi 2: Shtoni Integrimin e Docusaurus

1. Hyni në llogarinë tuaj të AI SmartTalk
2. Shkoni te Cilësimet → Integrimet
3. Gjeni Docusaurus dhe klikoni Lidhni
4. Futni URL-në e hartës tuaj të faqes
5. Klikoni Validoni

Hapi 3: Konfiguroni Cilësimet e Importit

Pas validimit, konfiguroni importin tuaj:

Cilësimi	Përshkrimi
URL e Hartës së Faqeve	URL e plotë për sitemap.xml tuaj
Modelet e përfshira	Vetëm sinkronizoni faqet që përputhen me modelet (opsionale)
Modelet e përjashtuar	Anashkaloni faqe ose seksione specifike (opsionale)

Hapi 4: Filloni Importin

1. Klikoni Importoni Faqet
2. AI SmartTalk skanon çdo URL në hartën tuaj të faqes
3. Përmbajtja nxirret dhe shtohet në bazën tuaj të njohurive
4. Prisni që importi të përfundojë (progresi shfaqet)

Hapi 5: Verifikoni Importin

1. Shkoni te Njohuritë në AI SmartTalk
2. Faqet tuaja të dokumentacionit duhet të shfaqen
3. Testoni AI-n tuaj duke bërë pyetje rreth dokumenteve tuaja

---

Çfarë Sinkronizohet

Përmbajtja	Si Procesohet
Titulli i faqes	Përdoret si identifikues dokumenti
Përmbajtja e faqes	Teksti i plotë i nxjerrë nga HTML
Titujt	Ruajtur për strukturë
Blloqet e kodit	Të përfshira ashtu si janë
Tabelat	Konvertuar në format të lexueshëm
URL-të	URL e faqes ruhet për referencë

Nxjerrja e Përmbajtjes

AI SmartTalk nxjerr zonën kryesore të përmbajtjes dhe injoron:

• Menutë e navigimit
• Anashkallë
• Fundet
• Skriptet dhe stilet

---

Sjellja e Sinkronizimit

Importi Manual

Klikoni Import në cilësimet e integrimit për të:

• Marrë hartën më të fundit
• Shtuar faqe të reja
• Përditësuar faqet e ndryshuara
• Hequr faqet e fshira

Mbajtja e Dokumenteve të Freskëta

Për dokumentacion gjithmonë të azhurnuar:

1. Rifreskim manual: Klikoni Import pas publikimit të azhurnimeve
2. Sinkronizim të planifikuar: Përdorni SmartFlow për të automatizuar importet

Importi i Planifikuar SmartFlow

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

---

Modelet e URL-ve

Modelet përfshirëse

Vetëm sinkronizoni seksione specifike:

Modeli	Efekti
/docs/api/*	Vetëm dokumentacioni i API-së
/docs/guides/*	Vetëm seksioni i udhëzimeve
/blog/*	Vetëm postimet e blogut

Modelet përjashtuese

Anashkaloni disa faqe:

Modeli	Efekti
/docs/internal/*	Anashkaloni dokumentet e brendshme
/changelog	Anashkaloni faqen e ndryshimeve
*/draft-*	Anashkaloni faqet e draftit

---

Rastet e Përdorimit

Boti i Mbështetjes Teknike

Sinkronizoni dokumentacionin e produktit tuaj:

• "Si ta instaloj SDK-në?"
• "Cilat janë kufijtë e normave të API-së?"
• "Më trego një shembull të autentikimit"

Dokumentacioni për Zhvilluesit

Sinkronizoni referencat dhe udhëzimet e API-së:

• "Cilat parametra pranon pika e fundit /users?"
• "Si të trajtoj webhook-et?"
• "Cila është diferenca midis API-së v1 dhe v2?"

Baza e Njohurive të Brendshme

Sinkronizoni wikit dhe procedurat e kompanisë:

• "Cili është procesi për të kërkuar PTO?"
• "Si ta vendos zhvillimin tim ambient?"
• "Ku mund të gjej udhëzimet për markën?"

---

Zgjidhja e Problemeve

Problemet me Hartën e Siteve

Problemi	Zgjidhja
"Harta e siteve e pavlefshme"	Verifikoni që URL-ja kthen XML të vlefshëm
"Nuk u gjetën faqe"	Kontrolloni që harta e siteve përmban hyrje <url>
"Qasje e mohuar"	Sigurohuni që harta e siteve është e aksesueshme publikisht

Problemet me Importin

Problemi	Zgjidhja
Faqet e humbura	Kontrolloni modelet përfshirëse/përjashtuese
Importi i ngecur	Site të mëdha kërkojnë kohë; prisni ose importoni në grupe
Përmbajtja e vjetër	Rimportoni për të marrë versionet më të fundit

Cilësia e Përmbajtjes

Problemi	Zgjidhja
Përmbajtja e gabuar e nxjerrë	Raportoni problemin—mund të nevojitet nxjerrje e personalizuar
Blloqet e kodit të humbura	Verifikoni që kodi është në etiketat standarde <pre><code>
Teksti i çrregullt	Kontrolloni kodimin e faqes (UTF-8 e rekomanduar)

---

Menaxhimi i Integrimit

Veprimi	Si
Rimportoni të gjitha	Klikoni Import në cilësimet e integrimit
Ndryshoni hartën e siteve	Azhurnoni URL-në dhe rimportoni
Hiqni përmbajtjen	Ç’lidheni integrimin ose fshini nga Njohuria
Ç’lidheni	Cilësimet → Integrimet → Docusaurus → Ç’lidheni

---

Praktikat më të Mira

1. Përmbajtje cilësore: Dokumente të shkruara mirë = përgjigje më të mira nga AI
2. Strukturë e qartë: Përdorni tituj, lista, dhe tabela
3. Tituj përshkrues: Titujt e faqeve ndihmojnë AI-n të kuptojë kontekstin
4. Sinkronizime të rregullta: Mbani AI-n të përditësuar me dokumentacionin më të fundit
5. Testoni në thellësi: Bëni pyetje të zakonshme për të verifikuar saktësinë e AI

---

Këshilla për Konfigurimin e Docusaurus

Optimizoni për Ekstraktimin nga AI

Në docusaurus.config.js tuaj:

module.exports = {
  // Sigurohuni që sitemap të gjenerohet
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Përdorni tituj përshkrues të faqeve
  title: 'Dokumentet e Produktit Tuaj',
  
  // Përfshini metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Dokumentacion për Produktin Tuaj'
    }],
  },
};

Përjashtoni Faqet nga Sitemap

Për të parandaluar që disa faqe të sinkronizohen:

// Në frontmatter e faqes
---
title: Faqe e Brendshme
sitemap:
  exclude: true
---

---

Dokumentacion i Lidhur

• Përmbledhja e Integrimeve
• Menaxhimi i Bazës së Njohurive
• Integrimi i RSS Feed — Për përmbajtjen e blogut/lajmeve
• Trigger të Planifikuara të SmartFlow — Automatizoni importet