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

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؟"
  • "كيف يمكنني التعامل مع webhooks؟"
  • "ما الفرق بين API v1 و v2؟"

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

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

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

استكشاف الأخطاء​

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

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

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

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

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

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

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

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

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

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

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

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

في ملف docusaurus.config.js:

module.exports = {
  // Ensure sitemap is generated
  plugins: ['@docusaurus/plugin-sitemap'],
  
  // Use descriptive page titles
  title: 'Your Product Docs',
  
  // Include metadata
  themeConfig: {
    metadata: [{
      name: 'description',
      content: 'Documentation for Your Product'
    }],
  },
};

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

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

// In page frontmatter
---
title: Internal Page
sitemap:
  exclude: true
---

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

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

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

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