انتقل إلى المحتوى الرئيسي

Docusaurus

قم بمزامنة موقع توثيق Docusaurus الخاص بك مع قاعدة المعرفة في AI SmartTalk. سيتعلم الذكاء الاصطناعي من كل صفحة في خريطة الموقع الخاصة بك - مثالي لروبوتات الدعم التي تجيب على الأسئلة التقنية.

نظرة عامة​

تتيح لك تكامل Docusaurus:

  • استيراد جميع الصفحات من خريطة الموقع الخاصة بك تلقائيًا
  • مزامنة الوثائق عند نشر التحديثات
  • الإجابة على الأسئلة حول توثيقك بشكل محادثاتي
  • تقليل عبء الدعم من خلال السماح للذكاء الاصطناعي بالتعامل مع الأسئلة الشائعة

معلومة ممتعة: يستخدم توثيق AI SmartTalk الخاص Docusaurus، ويقوم هذا التكامل بتشغيل روبوت الدعم لدينا!

المتطلبات السابقة​

قبل أن تبدأ، تأكد من أنك تمتلك:

  • حساب نشط في AI SmartTalk
  • موقع Docusaurus يحتوي على sitemap.xml صالح
  • يجب أن يكون موقعك متاحًا للجمهور (أو توفير المصادقة)

إعداد خطوة بخطوة​

الخطوة 1: تحديد موقع خريطة الموقع الخاصة بك​

ينشئ Docusaurus خريطة موقع تلقائيًا. ابحث عنها في:

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

تحقق من أنها تُحمّل في متصفحك وتحتوي على صفحات التوثيق الخاصة بك.

الخطوة 2: إضافة تكامل Docusaurus​

  1. قم بتسجيل الدخول إلى حساب AI SmartTalk الخاص بك
  2. انتقل إلى الإعدادات → التكاملات
  3. ابحث عن Docusaurus وانقر على اتصال
  4. أدخل عنوان URL لخريطة الموقع الخاصة بك
  5. انقر على تحقق

الخطوة 3: تكوين إعدادات الاستيراد​

بعد التحقق، قم بتكوين الاستيراد الخاص بك:

الإعدادالوصف
عنوان URL لخريطة الموقععنوان URL الكامل لـ sitemap.xml الخاص بك
أنماط الشمولمزامنة الصفحات التي تتطابق مع الأنماط فقط (اختياري)
أنماط الاستبعادتخطي صفحات أو أقسام معينة (اختياري)

الخطوة 4: بدء الاستيراد​

  1. انقر على استيراد الصفحات
  2. يقوم AI SmartTalk بالزحف إلى كل عنوان URL في خريطة الموقع الخاصة بك
  3. يتم استخراج المحتوى وإضافته إلى قاعدة المعرفة الخاصة بك
  4. انتظر حتى يكتمل الاستيراد (يتم عرض التقدم)

الخطوة 5: التحقق من الاستيراد​

  1. انتقل إلى المعرفة في AI SmartTalk
  2. يجب أن تظهر صفحات التوثيق الخاصة بك
  3. اختبر الذكاء الاصطناعي الخاص بك من خلال طرح أسئلة حول الوثائق الخاصة بك

ما الذي يتم مزامنته​

المحتوىكيفية معالجته
عنوان الصفحةيُستخدم كمعرف الوثيقة
محتوى الصفحةالنص الكامل المستخرج من HTML
العناوينمحفوظة من أجل الهيكل
كتل الشيفرةمدرجة كما هي
الجداولمحولة إلى تنسيق مقروء
عناوين URLيتم تخزين عنوان URL للصفحة للرجوع إليه

استخراج المحتوى​

يستخرج AI SmartTalk منطقة المحتوى الرئيسية ويتجاهل:

  • قوائم التنقل
  • الشريط الجانبي
  • التذييلات
  • السكربتات والأنماط

سلوك المزامنة​

الاستيراد اليدوي​

انقر على استيراد في إعدادات التكامل لـ:

  • جلب خريطة الموقع الأخيرة
  • إضافة صفحات جديدة
  • تحديث الصفحات التي تم تغييرها
  • إزالة الصفحات المحذوفة

الحفاظ على الوثائق محدثة​

للحصول على توثيق دائم التحديث:

  1. تحديث يدوي: انقر على استيراد بعد نشر التحديثات
  2. مزامنة مجدولة: استخدم SmartFlow لأتمتة الاستيرادات

استيراد مجدول باستخدام SmartFlow​

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

أنماط URL​

أنماط الشمول​

مزامنة أقسام معينة فقط:

النمطالتأثير
/docs/api/*توثيق API فقط
/docs/guides/*قسم الأدلة فقط
/blog/*مقالات المدونة فقط

أنماط الاستبعاد​

تخطي صفحات معينة:

النمطالتأثير
/docs/internal/*تخطي الوثائق الداخلية
/changelogتخطي صفحة سجل التغييرات
*/draft-*تخطي صفحات المسودات

حالات الاستخدام​

روبوت دعم فني​

مزامنة توثيق المنتج الخاص بك:

  • "كيف يمكنني تثبيت SDK؟"
  • "ما هي حدود معدل API؟"
  • "أرني مثالًا على المصادقة"

توثيق المطورين​

مزامنة مراجع API والأدلة:

  • "ما هي المعلمات التي يقبلها نقطة النهاية /users؟"
  • "كيف أتعامل مع الويب هوكس؟"
  • "ما الفرق بين v1 و v2 API؟"

قاعدة المعرفة الداخلية​

مزامنة ويكي الشركة والإجراءات:

  • "ما هي العملية المطلوبة لطلب إجازة مدفوعة؟"
  • "كيف يمكنني إعداد بيئة التطوير الخاصة بي؟"
  • "أين يمكنني العثور على إرشادات العلامة التجارية؟"

استكشاف الأخطاء وإصلاحها​

مشكلات خريطة الموقع​

المشكلةالحل
"خريطة الموقع غير صالحة"تحقق من أن عنوان URL يعيد XML صالح
"لا توجد صفحات"تحقق من أن خريطة الموقع تحتوي على إدخالات <url>
"تم رفض الوصول"تأكد من أن خريطة الموقع متاحة للجمهور

مشكلات الاستيراد​

المشكلةالحل
الصفحات مفقودةتحقق من أنماط الشمول/الاستبعاد
الاستيراد عالقالمواقع الكبيرة تستغرق وقتًا؛ انتظر أو استورد على دفعات
محتوى قديمأعد الاستيراد لجلب أحدث الإصدارات

جودة المحتوى​

المشكلةالحل
تم استخراج محتوى خاطئأبلغ عن المشكلة - قد تحتاج إلى استخراج مخصص
كتل الشيفرة مفقودةتحقق من أن الشيفرة في علامات <pre><code> القياسية
نص مشوشتحقق من ترميز الصفحة (يوصى باستخدام UTF-8)

إدارة التكامل​

الإجراءكيفية
إعادة استيراد الكلانقر على استيراد في إعدادات التكامل
تغيير خريطة الموقعتحديث عنوان URL وإعادة الاستيراد
إزالة المحتوىفصل التكامل أو الحذف من المعرفة
فصل الاتصالالإعدادات → التكاملات → Docusaurus → فصل الاتصال

أفضل الممارسات​

  1. محتوى عالي الجودة: وثائق مكتوبة جيدًا = إجابات أفضل من الذكاء الاصطناعي
  2. هيكل واضح: استخدم العناوين والقوائم والجداول
  3. عناوين وصفية: تساعد عناوين الصفحات الذكاء الاصطناعي على فهم السياق
  4. مزامنة منتظمة: حافظ على تحديث الذكاء الاصطناعي بأحدث الوثائق
  5. اختبار شامل: اطرح أسئلة شائعة للتحقق من دقة الذكاء الاصطناعي

نصائح تكوين Docusaurus​

تحسين استخراج الذكاء الاصطناعي​

في ملف docusaurus.config.js الخاص بك:

module.exports = {
  // تأكد من إنشاء خريطة الموقع
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // استخدم عناوين صفحات وصفية
  title: 'وثائق منتجك',
  
  // تضمين البيانات الوصفية
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'توثيق لمنتجك'
    }],
  },
};

استبعاد صفحات من خريطة الموقع​

لمنع مزامنة صفحات معينة:

// في مقدمة الصفحة
---
title: صفحة داخلية
sitemap:
  exclude: true
---

الوثائق ذات الصلة​

جاهز لرفع مستوى
تجربة المستخدم الخاصة بك؟

نشر مساعدي الذكاء الاصطناعي الذين يسعدون العملاء ويتناسبون مع عملك.

متوافق مع اللائحة العامة لحماية البيانات
ابدأ تجربة مجانيةالوصول إلى المكتب الخلفي