كتابة الوثائق¶
هذه هي الخطوات التي يجب اتباعها لكتابة مساهمتك في الوثائق لـ BeeWare.
قبل البدء في كتابة الوثائق، تأكد من أنك قادر على إنشاء الوثائق، وأنك تعمل على فرع.
تحديث الوثائق الموجودة¶
إذا كنت تقوم بتحرير المستندات الموجودة، فستحتاج إلى تحديد موقع الملف في الدليل
/docs/en. تتبع بنية الملف بنية الصفحة، لذا يمكنك تحديد موقع الملف باستخدام
عنوان URL الخاص بالوثائق.
إضافة وثائق جديدة¶
إذا كنت تضيف مستندًا جديدًا، فهناك بعض الخطوات الإضافية التي يجب اتباعها.
ستحتاج إلى إنشاء المستند في الموقع المناسب داخل دليل docs/en. لغرض المناقشة،
سنفترض أنك تضيف مستندًا جديدًا باسم الملف new_doc.md.
بعد ذلك، ستحتاج إلى تحديث ملف docs/en/SUMMARY.md لتضمين ملفك الجديد. يتم تنظيم
ملف SUMMARY.md بحيث يعكس بشكل أساسي بنية دليل docs/en، ولكن الأهم من ذلك أنه
يحدد بشكل مباشر بنية الشريط الجانبي الأيسر. إذا حددت المقطع الذي تريد تضمين
new_doc.md فيه، فلن تحتاج إلى تغيير أي شيء في SUMMARY.md إذا رأيت مسارًا
بديلًا مدرجًا. على سبيل المثال:
- ./path/to/directory/*
إذا كان القسم الذي تنوي تضمين new_doc.md فيه عبارة عن قائمة من روابط Markdown
الفردية، فستحتاج إلى إضافة رابط صريح إلى رابطك. على سبيل المثال:
- [My new document](new_doc.md)
كتابة الوثائق الخاصة بك¶
يمكنك الآن فتح الملف المطلوب في محررك وبدء الكتابة.
لدينا دليل أسلوب التوثيق الذي يحدد إرشاداتنا لكتابة وثائق BeeWare.
بمجرد أن تصبح راضيًا عن الوثائق الجديدة، يمكنك إرسال طلب سحب مع التغييرات المقترحة.