HeadlinesBriefing favicon HeadlinesBriefing.com

GitHub Wiki অ্যান্টি-প্যাটার্ন: Wiki না করে /docs ব্যবহার করুন

Hacker News •
×

"আমি কি উইকি ব্যবহার করব না GitHub-এ ডক্স ফোল্ডার?" এই আলোচনা প্রতি কয়েক মাস পর পুনরাবৃত্তি হয়। Shawn Wang-এর থ্রি স্ট্রাইক নিয়ম অনুসরণ করে, লেখক যুক্তি দেন যে GitHub-এ উইকি ব্যবহার একটি অ্যান্টি-প্যাটার্ন। উইকির একমাত্র সুবিধা হল এর নিরंतर উপলব্ধতা, কিন্তু এতে ভার্সনিং, লোকাল অ্যাক্সেস, পিয়ার রিভিউ এবং ব্র্যান্ডিং অপশনের অভাব রয়েছে। বিপরীতে, একটি /docs ফোল্ডার ডকুমেন্টেশনকে কোডের সাথে ইন্টিগ্রেট করে, ভার্সনিং সমর্থন করে, পুল রিকোয়েস্ট রিভিউ সক্ষম করে, এবং Vale এবং স্পেলচেকের মতো টুলের সাথে কাজ করে। উইকি আপলোড সমর্থন না করলে ছবিগুলো অন্য 어딘ো হোস্ট করতে হবে। ডক্স পাবলিশ করতে, just-the-docs-এর মতো থিম সহ GitHub Pages এবং একটি /docs ফোল্ডার ব্যবহার করুন। ডক্স কোডের সাথে ভার্সনড রাখতে gh-pages ব্রাঞ্চ এড়িয়ে চলুন। প্রজেক্টগুলো বড় হলে ডক্স আলাদা রেপোতে যেতে পারে, কিন্তু কন্ট্রিবিউটররা ইতিমধ্যে ওয়ার্কফ্লোর অভ্যস্ত থাকবে। লেখক টুইটারে ফিডব্যাক আমন্ত্রণ জানান।