قائمة مراجعة التوثيق
استخدم هذه القائمة عند مراجعة طلبات الدمج المعتمدة على التوثيق.
- اكتمل
./scripts/check_quality.shقبل الدمج - اكتمل
./scripts/check_representative_examples.shقبل الدمج - اكتمل
mdbook build docsعندما يتغير التوثيق أو الأمثلة أو نصوص الجذر - تم تحديث الصفحتين العربية والإنجليزية معًا عندما يكون التغيير موجّهًا للمستخدم
- أضيفت الصفحة إلى
docs/src/SUMMARY.md - وُضع المثال داخل الـ crate المالكة
- تم تحديث فهرس الأمثلة عند إضافة مثال جديد
- أضيفت روابط عكسية من الأمثلة المرجعية إلى صفحات الشرح عند الحاجة
- أضيف
rustdocللسطح العام الجديد عند موضع تعريفه - لم تُرفع المساعدات الداخلية إلى واجهة الوثائق المولدة دون قصد
- تستخدم الأوامر في التوثيق استدعاءات الأمثلة المرتبطة بالـ package عند الحاجة
- تم تحديث ملاحظات التحقق البصري عندما يتغير سلوك الأمثلة المرجعية أو سلوك الرندر
- تم تحديث
READMEوREADME_ARإذا تغيّرت قصة الدخول - تم تحديث
changelog.mdإذا كان التغيير ملحوظًا
جودة هندسية
- اكتمل
./scripts/check_public_api_surface.shعندما يتغير سطح الاستيراد أو تركيب الإضافات أو تعريض المسارات المهجورة - اكتمل
./scripts/check_engine_boundary_guardrails.shعند نقل المنطق بينengineوinteractionوwidgets - لم يضف التغيير hotspot كبيرة في ملفات المصدر دون سبب واضح
- لم يوسّع التغيير السطح العام أو الاقتران بلا حاجة موجّهة للمستخدم
- لم يضف التغيير اعتمادًا جديدًا على
univis_ui_engine::internalأو وحدات المحرك المخفية خارج crate المحرك - بقيت التسمية منسجمة مع صفحات التسمية والمعمارية الخاصة بالمحافظين