التحقق من البيانات الأمامية
يفحص الحقول المطلوبة مثل title وsidebar.order.
يجب أن تتضمن صفحات Splash حقول hero
وtemplate: splash.
f5xc-docs-tools
يتحقق مكوّن f5xc-docs-tools من صحة ملفات محتوى MDX لخط أنابيب توثيق f5-sales-demo. يرصد هذا المكوّن المشكلات الشائعة التي تُعطّل البناء قبل وصولها إلى CI، بما فيها أحرف JSX المكشوفة، والاستيرادات غير الصالحة، ومراجع الصور المعطوبة، والبيانات الأمامية غير المكتملة.
v1.1.2 Productivityالتثبيت
Section titled “التثبيت”/plugin install f5xc-docs-tools@f5-sales-demo-marketplaceالمهارات
Section titled “المهارات”mdx-content-reviewer
Section titled “mdx-content-reviewer”تُفعَّل هذه المهارة تلقائيًا عندما يكتشف Claude أنك تعمل مع ملفات MDX في مستودع محتوى f5-sales-demo. وتُجري سبعة فحوصات للتحقق من الصحة:
مزالق صياغة MDX
يكتشف أحرف < المكشوفة والأقواس \{ \}
غير المُهرَّبة التي تُعطّل تحليل MDX.
التحقق من الاستيرادات
يتحقق من صحة الاستيرادات مقابل قائمة مسموح بها من مكونات Starlight المدمجة ومكونات سمة f5-sales-demo.
سمات المكونات
يفحص الخصائص المطلوبة للمكونات مثل Screenshot, Aside, Code, LinkCard, Card, وBadge.
مراجع الصور
يتحقق من وجود الصور المُشار إليها في مجلد docs/images/.
فحوصات البنية
يضمن وجود docs/index.mdx وخلوّ مجلدات الصور
من ملفات MDX الدخيلة.
التصديرات وكتل الكود
يتحقق من أن المتغيرات المستخدمة في خاصية code
للمكوّن Code لها تصديرات مقابلة.
سلوك التحديد النطاق
Section titled “سلوك التحديد النطاق”تُحدّد المهارة نطاقها بذكاء أثناء المراجعة:
- إذا كانت هناك تغييرات غير مُودَعة أو مرحلية على ملفات
docs/**/*.mdx، تُراجَع تلك الملفات فقط - وإلا، تُراجَع جميع ملفات
docs/**/*.mdx
تنسيق المخرجات
Section titled “تنسيق المخرجات”تُجمَّع النتائج حسب درجة الخطورة:
- ERROR — سيُعطّل البناء؛ يجب الإصلاح قبل الدمج
- WARNING — مشكلات محتملة ينبغي معالجتها
- INFO — اقتراحات وأفضل الممارسات
تتضمن كل نتيجة مسار الملف، ورقم السطر، ووصفًا للمشكلة.
الأوامر
Section titled “الأوامر”/review-mdx
Section titled “/review-mdx”/f5xc-docs-tools:review-mdx [path-or-glob]يُشغّل مهارة mdx-content-reviewer عند الطلب.
الوسائط:
| الوسيط | مطلوب | الوصف |
|---|---|---|
path-or-glob | لا | مسار ملف أو نمط glob لتحديد نطاق المراجعة. الافتراضي هو جميع ملفات docs/**/*.mdx. |
أمثلة:
# مراجعة جميع ملفات MDX في docs//f5xc-docs-tools:review-mdx
# مراجعة ملف محدد/f5xc-docs-tools:review-mdx docs/getting-started.mdx
# مراجعة الملفات المطابقة لنمط glob/f5xc-docs-tools:review-mdx docs/guides/*.mdxالمخرجات: يُبلَّغ في نهاية المخرجات بسطر ملخص يعرض إجمالي الملفات التي جرت مراجعتها وعدد النتائج حسب درجة الخطورة.
الاستيرادات المسموح بها
Section titled “الاستيرادات المسموح بها”يتحقق المكوّن من صحة الاستيرادات مقابل هذه المصادر:
مكونات Starlight المدمجة (@astrojs/starlight/components):
Aside Badge Card CardGrid Code FileTree Icon
LinkCard Steps TabItem Tabs
مكونات سمة f5-sales-demo (@f5-sales-demo/docs-theme/components/):
Banner Icon LinkCard Screenshot
مرجع سريع للمكونات
Section titled “مرجع سريع للمكونات”| المكوّن | الخصائص المطلوبة | الخصائص الاختيارية |
|---|---|---|
| Screenshot | alt + واحدة على الأقل من light أو dark | — |
| Aside | type | title |
| Code | code، lang | title، frame، mark، ins، del |
| LinkCard (theme) | title، href | description، icon |
| Card | title | icon |
| Badge | text | variant |
| Steps | — | — |
| Tabs / TabItem | TabItem: label | — |
| CardGrid | — | — |
| FileTree | — | — |
مزالق MDX
Section titled “مزالق MDX”المشكلات الشائعة التي يرصدها المكوّن:
| المزلق | المشكلة | الحل |
|---|---|---|
< المكشوف | يُفسّره MDX بوصفه وسم JSX | استخدم &lt;، أو الكود المضمّن، أو أعد الصياغة |
\{ \} غير المُهرَّبة | يعامله MDX بوصفه تعبير JSX | استخدم الكود المضمّن، أو الهروب بـ \، أو كتلة الكود |
| الأقواس في أسماء الملفات | لا يستطيع Astro معالجة الملف | لا تستخدم \{ أو \} في أسماء ملفات .mdx |