نوشتن مستندات¶
اینها گامهایی هستند که باید برای نوشتن مشارکت مستندسازی خود در 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 را در آن قرار دهید شامل فهرستی از لینکهای
جداگانه مارکداون باشد، باید یک لینک صریح به لینک خود اضافه کنید. برای مثال:
- [My new document](new_doc.md)
نوشتن مستندات شما¶
اکنون میتوانید فایل مورد نظر را در ویرایشگر خود باز کرده و شروع به نوشتن کنید.
ما یک راهنمای سبک مستندسازی داریم که دستورالعملهای ما را برای نوشتن مستندسازی BeeWare تشریح میکند.
وقتی از مستندات جدیدتان راضی بودید، میتوانید یک درخواست کششی ارسال کنید که شامل تغییرات پیشنهادی شماست.