HeadlinesBriefing favicon HeadlinesBriefing.com

Anti-pola GitHub Wiki: Gunakan /docs Bukan Wiki

Hacker News •
×

Diskusi "apakah saya harus menggunakan wiki atau folder docs di GitHub?" muncul kembali setiap beberapa bulan. Mengikuti aturan three strikes Shawn Wang, penulis berargumen bahwa menggunakan wiki di GitHub adalah anti-pola. Satu-satunya keuntungan wiki adalah ketersediaannya yang konstan, tetapi wiki tidak memiliki versioning, akses lokal, peer review, dan opsi branding.

Sebaliknya, folder /docs mengintegrasikan dokumentasi dengan kode, mendukung versioning, mengaktifkan pull request review, dan bekerja dengan alat seperti Vale dan spellcheck. Gambar harus di-host di tempat lain karena wiki tidak mendukung unggahan. Untuk mempublikasikan docs, gunakan folder /docs dengan GitHub Pages dan tema seperti just-the-docs.

Hindari branch gh-pages agar docs tetap versioned bersama kode. Seiring proyek berkembang, docs mungkin pindah ke repo terpisah, tetapi kontributor sudah terbiasa dengan alur kerja. Penulis mengundang umpan balik di Twitter.