Docusaurus

Docusaurus belgelerinizi AI SmartTalk'ın bilgi tabanına senkronize edin. AI, site haritanızdaki her sayfadan öğrenir—teknik soruları yanıtlayan destek botları için mükemmel.

---

Genel Bakış

Docusaurus entegrasyonu, aşağıdakileri yapmanızı sağlar:

• Otomatik olarak site haritanızdaki tüm sayfaları içe aktarın
• Güncellemeleri yayınladığınızda belgelerinizi senkronize tutun
• Belgeleriniz hakkında soruları sohbet ederek yanıtlayın
• AI'nın yaygın soruları yanıtlamasına izin vererek destek yükünü azaltın

Eğlenceli bilgi: AI SmartTalk'ın kendi belgeleri Docusaurus'u kullanıyor ve bu entegrasyon destek chatbotumuzu güçlendiriyor!

---

Ön Koşullar

Başlamadan önce, aşağıdakilere sahip olduğunuzdan emin olun:

• Aktif bir AI SmartTalk hesabı
• Geçerli bir sitemap.xml ile Docusaurus sitesi
• Siteniz kamuya açık olmalı (veya kimlik doğrulama sağlamalı)

---

Adım Adım Kurulum

Adım 1: Site Haritanızı Bulun

Docusaurus otomatik olarak bir site haritası oluşturur. Bunu şu adreste bulabilirsiniz:

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

Tarayıcınızda yüklendiğini ve belgelerinizi içerdiğini doğrulayın.

Adım 2: Docusaurus Entegrasyonunu Ekleyin

1. AI SmartTalk hesabınıza giriş yapın
2. Ayarlar → Entegrasyonlar bölümüne gidin
3. Docusaurus'u bulun ve Bağlan butonuna tıklayın
4. Site haritanızın URL'sini girin
5. Doğrula butonuna tıklayın

Adım 3: İçe Aktarma Ayarlarını Yapılandırın

Doğrulamadan sonra, içe aktarmanızı yapılandırın:

Ayar	Açıklama
Site Haritası URL'si	sitemap.xml dosyanızın tam URL'si
Dahil etme desenleri	Sadece desenlerle eşleşen sayfaları senkronize edin (isteğe bağlı)
Hariç tutma desenleri	Belirli sayfaları veya bölümleri atlayın (isteğe bağlı)

Adım 4: İçe Aktarmayı Başlatın

1. Sayfaları İçe Aktar butonuna tıklayın
2. AI SmartTalk, site haritanızdaki her URL'yi tarar
3. İçerik çıkarılır ve bilgi tabanınıza eklenir
4. İçe aktarmanın tamamlanmasını bekleyin (ilerleme gösterilir)

Adım 5: İçe Aktarmayı Doğrulayın

1. AI SmartTalk'ta Bilgi bölümüne gidin
2. Belgelerinizin sayfaları görünmelidir
3. Belgeleriniz hakkında sorular sorarak AI'nizi test edin

---

Senkronize Olan İçerik

İçerik	Nasıl İşlenir
Sayfa başlığı	Belge tanımlayıcı olarak kullanılır
Sayfa içeriği	HTML'den çıkarılan tam metin
Başlıklar	Yapı için korunur
Kod blokları	Olduğu gibi dahil edilir
Tablolar	Okunabilir formata dönüştürülür
URL'ler	Referans için sayfa URL'si saklanır

İçerik Çıkarma

AI SmartTalk, ana içerik alanını çıkarır ve şunları göz ardı eder:

• Navigasyon menüleri
• Kenar çubukları
• Alt bilgiler
• Scriptler ve stiller

---

Senkronizasyon Davranışı

Manuel İçe Aktarma

Entegrasyon ayarlarında İçe Aktar butonuna tıklayarak:

• En son sitemap'i alın
• Yeni sayfalar ekleyin
• Değişen sayfaları güncelleyin
• Silinen sayfaları kaldırın

Belgeleri Güncel Tutma

Her zaman güncel belgeler için:

1. Manuel yenileme: Güncellemeleri yayımladıktan sonra İçe Aktar'a tıklayın
2. Zamanlanmış senkronizasyon: İçe aktarımları otomatikleştirmek için SmartFlow'u kullanın

SmartFlow Zamanlanmış İçe Aktarma

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

---

URL Desenleri

Dahil Etme Desenleri

Sadece belirli bölümleri senkronize edin:

Desen	Etki
/docs/api/*	Sadece API belgeleri
/docs/guides/*	Sadece kılavuzlar bölümü
/blog/*	Sadece blog yazıları

Hariç Tutma Desenleri

Belirli sayfaları atlayın:

Desen	Etki
/docs/internal/*	Dahili belgeleri atla
/changelog	Değişiklik günlüğü sayfasını atla
*/draft-*	Taslak sayfaları atla

---

Kullanım Senaryoları

Teknik Destek Botu

Ürün belgelerinizi senkronize edin:

• "SDK'yı nasıl kurarım?"
• "API hız limitleri nelerdir?"
• "Kimlik doğrulama örneği gösterin"

Geliştirici Belgeleri

API referanslarını ve kılavuzları senkronize edin:

• "/users uç noktası hangi parametreleri kabul eder?"
• "Webhook'ları nasıl yönetirim?"
• "v1 ve v2 API arasındaki fark nedir?"

Dahili Bilgi Tabanı

Şirket wikisini ve prosedürlerini senkronize edin:

• "PTO talep etme süreci nedir?"
• "Geliştirme ortamımı nasıl kurarım?"
• "Marka yönergelerini nerede bulabilirim?"

---

Sorun Giderme

Sitemap Sorunları

Sorun	Çözüm
"Geçersiz sitemap"	URL'nin geçerli XML döndürdüğünü doğrulayın
"Sayfa bulunamadı"	Sitemap'in <url> girişlerini içerdiğini kontrol edin
"Erişim reddedildi"	Sitemap'in herkese açık erişilebilir olduğundan emin olun

İçe Aktarma Sorunları

Sorun	Çözüm
Sayfalar eksik	Dahil etme/hariç tutma desenlerini kontrol edin
İçe aktarma takıldı	Büyük siteler zaman alır; bekleyin veya partiler halinde içe aktarın
Eski içerik	En son sürümleri almak için yeniden içe aktarın

İçerik Kalitesi

Sorun	Çözüm
Yanlış içerik çıkarıldı	Sorunu bildirin—özel çıkarım gerekebilir
Kod blokları eksik	Kodun standart <pre><code> etiketleri içinde olduğunu doğrulayın
Bozuk metin	Sayfa kodlamasını kontrol edin (UTF-8 önerilir)

---

Entegrasyonu Yönetme

Eylem	Nasıl
Tümünü yeniden içe aktar	Entegrasyon ayarlarında İçe Aktar'a tıklayın
Sitemap'i değiştir	URL'yi güncelleyin ve yeniden içe aktarın
İçeriği kaldır	Entegrasyonu koparın veya Bilgi'den silin
Bağlantıyı kes	Ayarlar → Entegrasyonlar → Docusaurus → Bağlantıyı kes

---

En İyi Uygulamalar

1. Kaliteli içerik: İyi yazılmış belgeler = daha iyi AI yanıtları
2. Açık yapı: Başlıklar, listeler ve tablolar kullanın
3. Açıklayıcı başlıklar: Sayfa başlıkları AI'nın bağlamı anlamasına yardımcı olur
4. Düzenli senkronizasyon: AI'yı en son belgelerle güncel tutun
5. Kapsamlı test edin: AI doğruluğunu doğrulamak için yaygın sorular sorun

---

Docusaurus Yapılandırma İpuçları

AI Çıkarımı için Optimize Edin

docusaurus.config.js dosyanızda:

module.exports = {
  // Site haritasının oluşturulduğundan emin olun
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Açıklayıcı sayfa başlıkları kullanın
  title: 'Ürününüzün Belgeleri',
  
  // Meta verileri dahil edin
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Ürününüz için Belgeler'
    }],
  },
};

Site Haritasından Sayfaları Hariç Tutun

Belirli sayfaların senkronize edilmesini önlemek için:

// Sayfa ön bilgisi içinde
---
title: Dahili Sayfa
sitemap:
  exclude: true
---

---

İlgili Belgeler

• Entegrasyonlar Genel Bakış
• Bilgi Tabanı Yönetimi
• RSS Beslemesi Entegrasyonu — Blog/haber içeriği için
• SmartFlow Zamanlanmış Tetikleyiciler — İçe aktarmaları otomatikleştirin