عن المشروع

Beautiful Docs هو مرجع منسّق للأشخاص الذين ينشئون توثيقًا للبرمجيات أو لمشروعات أخرى موجهة إلى مستخدمين متعددين. وهو لا يولّد التوثيق بنفسه، بل يربط إلى أمثلة تحظى بتقدير واسع وموارد داعمة. تشمل أمثلة التوثيق مراجع للغات وأطر العمل، وأدلة لواجهات برمجة التطبيقات، وكتيّبات أنظمة التشغيل، وقواعد البيانات، وخدمات المطورين. ومن بين الإدراجات Redis Commands، وGitHub Developer Docs، وDjango، وRuby on Rails، وStripe، وRust، وMongoDB، وFastAPI، وSupabase. وتسلّط بعض الإدراجات الضوء على صفات معينة مثل الأمثلة التفاعلية، وإدارة الإصدارات، والبحث، والكتابة الموجزة، والمخططات، والتنقل، ودعم اللغات. يغطي قسم ثانٍ موارد الكتابة التقنية وتصميم التوثيق، بما في ذلك TomDoc، وWrite the Docs، وGoogle Developer Documentation Style Guide، وAPI Blueprint، وDiátaxis. ويسرد القسم الأخير أدوات لإنشاء التوثيق أو تحويله أو نشره أو صيانته، مثل Sphinx، وMkDocs، وRead the Docs، وSlate، وDocusaurus، وVuePress، وVitePress، وDocsify، وPandoc، وDoxygen. تتم صيانة المستودع من خلال طلبات السحب. ويُطلب من المساهمين شرح سبب فائدة العنصر، والتعريف بأنفسهم أو بالمساهم الأصلي، والحفاظ على ترتيب الإضافة في القائمة.