منصوبے کے بارے میں

DevDocs مختلف ڈویلپر ڈاکومنٹیشنز تک رسائی کے لیے ایک متحد ویب UI فراہم کرتا ہے۔ اسے رفتار اور کارکردگی کے لیے ڈیزائن کیا گیا ہے، جس میں فوری تلاش، کی بورڈ شارٹ کٹس، ڈارک تھیم، اور موبائل فرینڈلی ورژن شامل ہیں۔ اس پلیٹ فارم کی ایک اہم صلاحیت اس کی آف لائن سپورٹ ہے، جو ڈویلپرز کو انٹرنیٹ کنکشن کے بغیر ڈاکومنٹیشن تک رسائی کی اجازت دیتی ہے۔ اس پروجیکٹ کے دو بنیادی اجزاء ہیں: 1. ایک Ruby پر مبنی scraper جو تیسرے فریق کے ذرائع سے HTML ڈاکومنٹیشن ڈاؤن لوڈ، کلین اور نارملائز کرتا ہے، اور ضروری میٹا ڈیٹا اور انڈیکس فائلیں تیار کرتا ہے۔ 2. ایک کلائنٹ سائیڈ JavaScript ایپلی کیشن جسے ایک چھوٹے Sinatra/Sprockets بیک اینڈ کے ذریعے چلایا جاتا ہے جو مواد کو رینڈر کرتا ہے۔ صارفین DevDocs کو devdocs.io پر ہوسٹ شدہ ورژن کے ذریعے یا Docker یا مینوئل Ruby انسٹالیشن کا استعمال کرتے ہوئے سیلف ہوسٹ کر سکتے ہیں۔ یہ ٹول خاص طور پر API اور ریفرنس مواد پر توجہ مرکوز کرتا ہے تاکہ بے ترتیب مواد کو کم کیا جا سکے اور ڈویلپرز کے لیے سیاق و سباق کی تبدیلی (context switching) کو کم کیا جا سکے۔