تنضم DevDocs إلى مجتمع freeCodeCamp

DevDocs هو تطبيق ويب مفتوح المصدر يجمع الوثائق الخاصة بالعديد من أدوات المطورين في واجهة واحدة قابلة للبحث.

لقد كنت أستخدم DevDocs منذ ذلك الحين قبل وجود freeCodeCamp ، وقد أشادت به على مر السنين.

تُعد سرعة وبساطة DevDocs بمثابة نفس حقيقي للهواء النقي. تم وضع كل واجهة برمجة تطبيقات في نفس التسلسل الهرمي الواضح.

لذلك عندما حان وقت تصميم دليل freeCodeCamp الصيف الماضي ، كان لدي بالفعل نموذج واضح في ذهني. كنا بصدد إنشاء واجهة شبيهة بـ DevDocs لاستكشاف مفاهيم البرمجة.

لقد تواصلت مع منشئ DevDocs Thibaut Courouble للحصول على المشورة. لقد كان مفيدًا في شرح كيفية عمل DevDocs ومنطقه وراء بعض قرارات التصميم الخاصة به.

ظل هو وأنا على اتصال. تبادلنا الأفكار حول كيفية صنع أدوات يمكن الوصول إليها بسهولة أكبر للمطورين في أجزاء من العالم بدون اتصالات إنترنت موثوقة عالية السرعة.

بعد ذلك ، قبل شهرين ، تواصل معي Thibaut حول إمكانية التبرع بمشروع DevDocs لمجتمع freeCodeCamp ، حتى نتمكن من الاستمرار في تطوير المشروع بما يتجاوز ما يمكنه القيام به بصفته مشرفًا منفردًا.

واليوم - بعد 5 سنوات بالضبط من قيام Thibaut بإنشاء DevDocs - يسعدني أن أعلن أن DevDocs أصبح رسميًا الآن جزءًا من مجتمع freeCodeCamp!

نبذة تاريخية عن DevDocs

Thibaut هو مطور فرنسي يعمل الآن كمسؤول تطوير كبير في Shopify في أوتاوا ، كندا.

أنشأ Thibaut DevDocs منذ 5 سنوات بالضبط اليوم ، في 26 مارس 2013. في ذلك الوقت ، أراد فقط طريقة أفضل للوصول بسرعة إلى وثائق شبكة مطوري Mozilla.

في الأصل ، كان DevDocs مجرد مجلد وثائق عادي على قرصه الصلب ، لاستخدامه الشخصي - وهو النوع الذي كان لدى العديد من المطورين كمرجع. بعد ذلك ، وبعد بضعة أشهر من التطوير ، أطلق Thibaut DevDocs في 18 يونيو 2013 كتطبيق ويب مجاني.

في البداية ، أبقى Thibaut على DevDocs مغلقًا. لكن في 24 أكتوبر 2013 ، فتحها.

استمر مشروع DevDocs منذ ذلك الحين في تجميع أكثر من 17000 نجم على GitHub ، إلى جانب 66 مساهمًا (على الرغم من أن Thibaut لا يزال حتى الآن المساهم الأكثر إنتاجًا).

كتب Thibaut العشرات من نصوص الكشط للخروج وتنزيل الوثائق تلقائيًا من مشاريع مختلفة ، كل منها تم ضبطه بعناية لإنشاء تجربة قراءة متسقة وإنشاء نتائج بحث جيدة.

على مدار العامين المقبلين ، أضاف Thibaut العديد من التحسينات مثل التوثيق الجديد واختصارات لوحة المفاتيح والبحث الأفضل ودعم الهاتف المحمول والقدرة على التبديل إلى المظهر الداكن للعرض ليلاً.

بعد ذلك ، في عام 2015 ، جعل Thibaut DevDocs يعمل بشكل كامل في وضع عدم الاتصال. فجأة ، يمكن لأي شخص تنزيل مجموعات كاملة من الوثائق للوصول إليها في وضع عدم الاتصال. سيتم تخزين كل هذه الملفات في المتصفح ، وذلك بفضل الاستخدام الذكي لتقنية جديدة تسمى IndexedDB.

وفي أوائل عام 2016 ، أضاف Thibaut دعمًا للإصدار. بدلاً من أن يقتصر على أحدث إصدار من الوثائق فقط ، بدأت DevDocs الآن في دعم إصدارات متعددة لكل مشروع ومكتبة.

ستصبح هاتان الميزتان الرئيسيتان الجديدتان نقطة انعطاف في قاعدة مستخدمي DevDocs. نما المشروع ليصبح أحد أكثر الأدوات استخدامًا في مجتمع المطورين.

إذا كنت تريد معرفة المدى الذي وصل إليه DevDocs في السنوات الخمس الماضية ، فقارن بين هذين الموضوعين من سلاسل أخبار Hacker:

  1. الخيط الأول من يونيو 2013 - معظمهم من الناس يقارنون بشكل غير مفضل DevDocs بمشاريع التوثيق الأخرى (العديد منها لم يعد موجودًا الآن).
  2. سلسلة ثانية من أواخر عام 2017 - في واحدة من أكثر المواضيع التي حظيت بالتصويت على موقع Hacker News على الإطلاق ، يمتدح الناس DevDocs - لا سيما بسبب سرعته. الرسالة واضحة: ليس من الضروري أن يكون مشروعك هو الأول من نوعه - عليك فقط الالتزام به وإجراء تحسينات متسقة عليه ، ويمكنك أن تبرز كقائد.

اليوم ، يستخدم أكثر من 100،000 مطور DevDocs كمرجع كل شهر.

كيف يعمل DevDocs تحت الغطاء

أحد الأسئلة الأكثر شيوعًا التي يطرحها الناس على Thibaut: كيف أصبح DevDocs سريعًا جدًا؟

يعزو Thibaut سرعة DevDocs إلى عدة عوامل:

  • DevDocs هو تطبيق ويب Ruby من صفحة واحدة مع خلفية صغيرة جدًا.
  • عند زيارة DevDocs.io ، بعد تحميل الصفحة الأولية ، يتم جلب جميع الملفات اللاحقة (بما في ذلك ملفات التوثيق) من خلال شبكة توصيل المحتوى (CDN) بسرعة البرق.
  • يستخدم GZIP و HTTP caching و App Cache و JavaScript متسلسل ومُصغر و CSS
  • لا توجد إعلانات (الإعلانات تبطئ كل شيء)
  • يستخدم localStorage كمستوى إضافي من التخزين المؤقت لبعض الأصول
  • يستخدم ذاكرة تخزين مؤقت في الذاكرة لأشياء مثل التنقل الفوري للخلف والأمام
  • يستخدم IndexedDB للتخزين المؤقت لمجموعات كاملة من الوثائق محليًا على جهاز الكمبيوتر الخاص بك
  • يتم تجريد الوثائق من جميع الأصول البعيدة والترميز غير الضروري ، مما ينتج عنه ملفات أصغر
  • يستخدم البحث الأمثل من جانب العميل
  • يحتوي على واجهة مستخدم غير قابلة للحظر وغير متزامنة
  • تتميز بشجرة DOM مُحسّنة مع قائمة شريط جانبي مرقّم الصفحات ، بحيث لا تضطر إلى عرض 1000 عقد على الفور
  • يحتوي على واجهة مستخدم بسيطة تتجنب الرتوش مثل الظلال أو الرسوم المتحركة

أخيرًا ، لا يستخدم DevDocs أي jQuery أو أي أطر عمل JavaScript. يتم تنفيذ جميع عمليات DOM يدويًا ، مما يجعلها أسرع ما يمكن. (يقول Thibaut إنه لن يوصي بهذا النهج بدون إطار عمل لمعظم التطبيقات ، لكنه يعمل جيدًا مع DevDocs.)

كيف يمكنك المشاركة

في الوقت الحالي ، نحن نبحث عن مطور Ruby شغوفًا وذو خبرة ويهتم بأن يصبح مساهمًا على المدى الطويل في DevDocs.

نحن نبحث أيضًا عن الأشخاص المهتمين بتسهيل المساهمة في DevDocs ، من خلال كتابة الوثائق وإعادة بناء التعليمات البرمجية.

يمكنك أيضًا المساعدة من خلال الإبلاغ عن أي أخطاء أو طلبات ميزات لديك في أداة تعقب المشكلات ، والمساعدة في فرزها أو إصلاحها.

يمكنك الانضمام إلى غرفة دردشة المساهمين في DevDocs على Gitter وتقديم نفسك.

أخيرًا ، يمكنك المساعدة باستخدام DevDocs ومشاركتها مع أصدقائك وزملائك. في المرة التالية التي تحتاج فيها إلى البحث عن الوثائق ، انتقل إلى DevDocs.io.

يمكنك أيضًا البحث في DevDocs باستخدام كتابة "devdocs" في شريط عنوان Chrome والضغط على علامة التبويب. ولدى !ddDuckDuckGo أمر خاص للبحث في DevDocs أيضًا.

انضم إليَّ في الترحيب بـ Thibaut و DevDocs في مجتمع freeCodeCamp من خلال التغريد عليه.

استمتع ، وأتمنى لك ترميز سعيد