Docusaurus

Docusaurus sənəd saytınızı AI SmartTalk-ın bilik bazasına sinxronlaşdırın. Sizin AI, sayt xəritənizdəki hər bir səhifədən öyrənəcək - texniki suallara cavab verən dəstək botları üçün mükəmməldir.

---

Ümumi Məlumat

Docusaurus inteqrasiyası sizə imkan verir:

• İdxal edin sayt xəritənizdəki bütün səhifələri avtomatik
• Sənədləri sinxron saxlayın yeniləmələr dərc edildikdə
• Sual verin sənədləriniz haqqında söhbət şəklində
• Dəstək yükünü azaldın AI-nin ümumi sualları cavablandırmasına icazə verərək

Maraqlı fakt: AI SmartTalk-ın öz sənədləri Docusaurus-dan istifadə edir və bu inteqrasiya bizim dəstək chatbotumuzu gücləndirir!

---

Tələblər

Başlamazdan əvvəl, aşağıdakılara əmin olun:

• Aktiv AI SmartTalk hesabı
• Etibarlı sitemap.xml olan Docusaurus saytı
• Saytınız açıq şəkildə əlçatan olmalıdır (ya da autentifikasiya təmin etməlidir)

---

Addım-addım Quraşdırma

Addım 1: Sayt Xəritənizi Tapın

Docusaurus avtomatik olaraq sayt xəritəsi yaradır. Onu burada tapın:

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

Onun brauzerinizdə yükləndiyini və sənəd səhifələrinizi ehtiva etdiyini təsdiqləyin.

Addım 2: Docusaurus Inteqrasiyasını Əlavə Edin

1. AI SmartTalk hesabınıza daxil olun
2. Ayarlar → İnteqrasiyalar bölməsinə keçin
3. Docusaurus-u tapın və Bağlan düyməsini basın
4. Sayt xəritənizin URL-sini daxil edin
5. Təsdiq et düyməsini basın

Addım 3: İdxal Parametrlərini Konfiqurasiya Edin

Təsdiqdən sonra idxalınızı konfiqurasiya edin:

Parametr	Təsvir
Sayt Xəritəsi URL	sitemap.xml-nizin tam URL-i
Daxil etmə nümunələri	Yalnız nümunələrə uyğun gələn səhifələri sinxronlaşdırın (isteğe bağlı)
Xaric etmə nümunələri	Müəyyən səhifələri və ya bölmələri atlayın (isteğe bağlı)

Addım 4: İdxalı Başlayın

1. Səhifələri İdxal et düyməsini basın
2. AI SmartTalk sayt xəritənizdəki hər bir URL-ni araşdırır
3. Məzmun çıxarılır və bilik bazanıza əlavə edilir
4. İdxalın tamamlanmasını gözləyin (irəliləyiş göstərilir)

Addım 5: İdxalı Təsdiqləyin

1. AI SmartTalk-da Bilik bölməsinə keçin
2. Sizin sənəd səhifələriniz görünməlidir
3. Sənədləriniz haqqında suallar verərək AI-nizi test edin

---

Nə Sinxronlaşdırılır

Məzmun	Necə Emal Olunur
Səhifə başlığı	Sənəd identifikatoru kimi istifadə olunur
Səhifə məzmunu	HTML-dən çıxarılan tam mətn
Başlıqlar	Struktur üçün saxlanılır
Kod blokları	Olduğu kimi daxil edilir
Cədvəllər	Oxunaqlı formata çevrilir
URL-lər	İstinad üçün səhifə URL-i saxlanılır

Məzmunun Çıxarılması

AI SmartTalk əsas məzmun sahəsini çıxarır və aşağıdakılara diqqət yetirmir:

• Navigasiya menyuları
• Yan çubuqlar
• Altlıqlar
• Skriptlər və stillər

---

Sinxronizasiya Davranışı

Əl İlə İdxal

İnteqrasiya parametrlərində İdxal düyməsini basın:

• Ən son sayt xəritəsini əldə edin
• Yeni səhifələr əlavə edin
• Dəyişdirilmiş səhifələri yeniləyin
• Silinmiş səhifələri çıxarın

Sənədləri Yeniləmək

Həmişə aktual sənədləşmə üçün:

1. Əl ilə yeniləmə: Yeniləmələri dərc etdikdən sonra İdxal düyməsini basın
2. Cədvəl üzrə sinxronizasiya: İdxalları avtomatlaşdırmaq üçün SmartFlow istifadə edin

SmartFlow Cədvəl üzrə İdxal

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

---

URL Nümunələri

Daxil Etmə Nümunələri

Yalnız spesifik bölmələri sinxronizasiya edin:

Nümunə	Təsir
/docs/api/*	Yalnız API sənədləri
/docs/guides/*	Yalnız bələdçi bölməsi
/blog/*	Yalnız blog yazıları

Çıxarma Nümunələri

Bəzi səhifələri atlaya bilərsiniz:

Nümunə	Təsir
/docs/internal/*	Daxili sənədləri atlaya bilərsiniz
/changelog	Dəyişikliklər səhifəsini atlaya bilərsiniz
*/draft-*	Taslak səhifələri atlaya bilərsiniz

---

İstifadə Halları

Texniki Dəstək Botu

Məhsul sənədlərinizi sinxronizasiya edin:

• "SDK-nı necə quraşdırım?"
• "API sürət limitləri nədir?"
• "Mənə autentifikasiya nümunəsi göstərin"

İnkişaf etdirici Sənədləşməsi

API istinadlarını və bələdçiləri sinxronizasiya edin:

• " /users son nöqtəsi hansı parametrləri qəbul edir?"
• "Webhooks-u necə idarə edim?"
• "v1 və v2 API arasında nə fərq var?"

Daxili Bilgi Bazası

Şirkət viki və prosedurlarını sinxronizasiya edin:

• "PTO tələb etmək prosesi nədir?"
• "İnkişaf mühitimi necə qura bilərəm?"
• "Marka qaydalarını harada tapa bilərəm?"

---

Problemlərin Həlli

Sayt Xəritəsi Problemləri

Problemi	Həll
"Yanlış sayt xəritəsi"	URL-nin düzgün XML qaytardığını yoxlayın
"Heç bir səhifə tapılmadı"	Sayt xəritəsinin <url> girişlərini ehtiva etdiyini yoxlayın
"Giriş qadağan edildi"	Sayt xəritəsinin ictimaiyyətə açıq olduğuna əmin olun

İdxal Problemləri

Problemi	Həll
Səhifələr itkin	Daxil et/dışlama nümunələrini yoxlayın
İdxal dayandı	Böyük saytlar zaman alır; gözləyin və ya qruplar halında idxal edin
Köhnə məzmun	Ən son versiyaları əldə etmək üçün yenidən idxal edin

Məzmun Keyfiyyəti

Problemi	Həll
Yanlış məzmun çıxarıldı	Problemi bildirin—xüsusi çıxarma tələb oluna bilər
Kod blokları itkin	Kodun standart <pre><code> etiketlərində olduğunu yoxlayın
Qarışıq mətn	Səhifənin kodlamasını yoxlayın (UTF-8 tövsiyə olunur)

---

İnteqrasiyanı İdarə Etmək

Fəaliyyət	Necə
Hamısını yenidən idxal et	İnteqrasiya parametrlərində İdxal düyməsini basın
Sayt xəritəsini dəyişdir	URL-ni yeniləyin və yenidən idxal edin
Məzmunu sil	İnteqrasiyanı ayırın və ya Bilgi bazasından silin
Ayır	Parametrlər → İnteqrasiyalar → Docusaurus → Ayır

---

Ən Yaxşı Təcrübələr

1. Keyfiyyətli məzmun: Yaxşı yazılmış sənədlər = daha yaxşı AI cavabları
2. Aydın struktur: Başlıqlardan, siyahılardan və cədvəllərdən istifadə edin
3. Təsviredici başlıqlar: Səhifə başlıqları AI-nin konteksti başa düşməsinə kömək edir
4. Müntəzəm senkronizasiya: AI-nı ən son sənədlərlə yeniləyin
5. Dəqiq test edin: AI-nin dəqiqliyini təsdiqləmək üçün ümumi suallar verin

---

Docusaurus Konfiqurasiya İpuçları

AI Çıxarışı üçün Optimallaşdırın

Sizin docusaurus.config.js faylınızda:

module.exports = {
  // Sayt xəritəsinin yaradılmasını təmin edin
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Təsviredici səhifə başlıqlarından istifadə edin
  title: 'Your Product Docs',
  
  // Metadata daxil edin
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentation for Your Product'
    }],
  },
};

Sayt Xəritəsindən Səhifələri İstisna Edin

Bəzi səhifələrin senkronizasiya edilməsinin qarşısını almaq üçün:

// Səhifə ön məlumatında
---
title: Internal Page
sitemap:
  exclude: true
---

---

Əlaqəli Sənədlər

• İnteqrasiyalar Ümumi Məlumat
• Bilgi Bazası İdarəetməsi
• RSS Feed İnteqrasiyası — Blog/xəbər məzmunu üçün
• SmartFlow Cədvəl Tətikləri — İdxalları avtomatlaşdırın