Ana içeriğe atla

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ükemmeldir.


Genel Bakış

Docusaurus entegrasyonu ile şunları yapabilirsiniz:

  • Otomatik olarak site haritanızdaki tüm sayfaları içe aktarın
  • Güncellemeleri yayınladığınızda belgeleri 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 şunlara sahip olduğunuzdan emin olun:

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

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. AyarlarEntegrasyonlar 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:

AyarAçıklama
Site Haritası URL'sisitemap.xml dosyanızın tam URL'si
Dahil etme desenleriSadece desenlerle eşleşen sayfaları senkronize edin (isteğe bağlı)
Hariç tutma desenleriBelirli 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'nızı test edin

Senkronize Edilen İçerik

İçerikİşlenme Şekli
Sayfa başlığıBelge tanımlayıcı olarak kullanılır
Sayfa içeriğiHTML'den çıkarılan tam metin
BaşlıklarYapı için korunur
Kod bloklarıOlduğu gibi dahil edilir
TablolarOkunabilir formata dönüştürülür
URL'lerReferans 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
  • Yan paneller
  • Alt bilgiler
  • Scriptler ve stiller

Senkronizasyon Davranışı

Manuel İçe Aktarma

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

  • En son site haritasını 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ınladıktan sonra İçe Aktar butonuna tıklayın
  2. Zamanlanmış senkronizasyon: İçe aktarmaları otomatikleştirmek için SmartFlow 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:

DesenEtki
/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:

DesenEtki
/docs/internal/*Dahili belgeleri atlayın
/changelogDeğişiklik günlüğü sayfasını atlayın
*/draft-*Taslak sayfaları atlayın

Kullanım Senaryoları

Teknik Destek Botu

Ürün belgelerinizi senkronize edin:

  • "SDK'yı nasıl kurarım?"
  • "API hız limitleri nedir?"
  • "Bana kimlik doğrulama örneği göster"

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 wiki'lerini 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

Site Haritası Sorunları

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

İçe Aktarma Sorunları

SorunÇözüm
Sayfalar eksikDahil 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çerikEn 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
Eksik kod bloklarıKodun standart <pre><code> etiketlerinde olduğunu doğrulayın
Karışık metinSayfa kodlamasını kontrol edin (UTF-8 önerilir)

Entegrasyonu Yönetme

EylemNasıl
Tümünü yeniden içe aktarEntegrasyon ayarlarında İçe Aktar butonuna tıklayın
Site haritasını değiştirURL'yi güncelleyin ve yeniden içe aktarın
İçeriği kaldırEntegrasyonu koparın veya Bilgi'den silin
Bağlantıyı kesAyarlar → 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 senkronizasyonlar: AI'yı en son belgelerle güncel tutun
  5. Kapsamlı test: 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 Belgeleriniz',

// 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 verisinde
---
title: Dahili Sayfa
sitemap:
exclude: true
---

İlgili Belgeler

Deneyiminizi yükseltmeye hazır mısınız?
kullanıcı deneyimi?

Müşterileri memnun eden ve işinizle birlikte büyüyen AI asistanlarını dağıtın.

GDPR Uyumlu