مسار تأليف التوثيق

توضح هذه الصفحة مكان إضافة التوثيق وأمثلة التشغيل الجديدة.

أين تذهب صفحات التوثيق الجديدة

أضف صفحات الشرح الموجهة للمستخدم إلى docs/src/en وdocs/src/ar
حافظ على نفس هيكلة المعلومات في الشجرتين
ضع مواد الترحيل داخل docs/src/*/migration
اترك التفاصيل الدقيقة للتواقيع والحقول إلى rustdoc بدل تضخيم صفحات الشرح

أين تذهب أمثلة التشغيل الجديدة

إذا أضفت مثالًا قابلًا للتشغيل أو أعدت مثالًا قديمًا، فضعه داخل الـ crate المالكة للميزة
إذا عاد عرض متكامل على مستوى الواجهة المجمعة، يبقى الجذر examples/ موطنه المقصود
حدّث فهرس الأمثلة في اللغتين عندما تتغير حالة التوفر
أضف تعليقًا قصيرًا داخل المثال يشير إلى صفحة الشرح المرتبطة عندما يكون المثال مرجعيًا

كيفية إضافة صفحات متقابلة بين اللغتين

أنشئ الصفحة الإنجليزية
أنشئ الصفحة العربية النظيرة في المسار المقابل
أضف الصفحتين إلى docs/src/SUMMARY.md
حدّث هدف مبدّل اللغة إذا كانت الصفحة امتدادًا لفصل موجود

كيفية إضافة `rustdoc` عام

عند إضافة سطح API عام جديد:

أضف أو وسّع توثيق crate أو الوحدة إذا كان السطح الجديد يغير مسار الاكتشاف
وثّق النوع العام أو الإضافة عند موضع تعريفها
فضّل أمثلة no_run القصيرة
أخفِ المساعدات الداخلية إذا كانت ستلوّث القصة العامة في الوثائق المولدة

متى تحدّث `README` و`changelog`

حدّث README.md وREADME_AR.md إذا تغيّرت قصة الدخول من GitHub
حدّث changelog.md عند وجود تغيير ملحوظ في التوثيق أو الأمثلة أو السطح العام
استخدم اصطلاحات التسمية عند إضافة وحدات داخلية جديدة أو إعادة تسميتها