DevDocs bergabung dengan komunitas freeCodeCamp

DevDocs adalah aplikasi web sumber terbuka yang menggabungkan dokumentasi untuk banyak alat pengembang menjadi satu antarmuka yang dapat dicari.

Saya telah menggunakan DevDocs sejak sebelum freeCodeCamp ada, dan telah menyanyikan pujiannya selama bertahun-tahun.

Kecepatan dan kesederhanaan DevDocs benar-benar menghirup udara segar. Setiap API diatur dalam hierarki jelas yang sama.

Jadi, ketika tiba saatnya merancang Panduan freeCodeCamp musim panas lalu, saya sudah memiliki template yang jelas. Kami akan membuat antarmuka seperti DevDocs untuk menjelajahi konsep pemrograman.

Saya menghubungi pencipta DevDocs, Thibaut Courouble untuk meminta nasihat. Dia sangat membantu dalam menjelaskan bagaimana DevDocs bekerja dan alasan di balik beberapa keputusan desainnya.

Dia dan saya tetap berhubungan. Kami bertukar ide tentang cara membuat alat yang lebih dapat diakses oleh pengembang di belahan dunia tanpa sambungan internet berkecepatan tinggi yang andal.

Kemudian beberapa bulan yang lalu, Thibaut mendekati saya tentang kemungkinan mendonasikan proyek DevDocs ke komunitas freeCodeCamp, sehingga kami dapat terus mengembangkan proyek melebihi kemampuannya sebagai pemelihara tunggal.

Dan hari ini - tepat 5 tahun setelah Thibaut membuat DevDocs - dengan senang hati saya mengumumkan bahwa DevDocs sekarang secara resmi menjadi bagian dari komunitas freeCodeCamp!

Sejarah singkat DevDocs

Thibaut adalah pengembang Prancis yang sekarang bekerja sebagai pemimpin pengembangan senior di Shopify di Ottawa, Kanada.

Thibaut membuat DevDocs tepat 5 tahun yang lalu hari ini, pada 26 Maret 2013. Saat itu, dia hanya menginginkan cara yang lebih baik untuk mengakses dokumentasi Jaringan Pengembang Mozilla dengan cepat.

Awalnya, DevDocs hanyalah folder dokumentasi biasa di hard drive-nya, untuk penggunaan pribadinya - jenis yang dimiliki oleh banyak pengembang sebagai referensi. Kemudian, setelah beberapa bulan pengembangan, Thibaut meluncurkan DevDocs pada 18 Juni 2013, sebagai aplikasi web gratis.

Pada awalnya, Thibaut menyimpan DevDocs sebagai sumber tertutup. Namun pada 24 Oktober 2013, dia melakukan open source.

Proyek DevDocs telah mengumpulkan lebih dari 17.000 bintang GitHub, bersama dengan 66 kontributor (meskipun Thibaut sejauh ini masih menjadi kontributor paling produktif).

Thibaut menulis lusinan skrip penggalian untuk dikeluarkan dan secara otomatis mengunduh dokumentasi dari berbagai proyek, masing-masing disetel dengan cermat untuk menciptakan pengalaman membaca yang konsisten dan menghasilkan hasil penelusuran yang baik.

Selama dua tahun berikutnya, Thibaut menambahkan banyak peningkatan seperti dokumentasi baru, pintasan keyboard, pencarian yang lebih baik, dukungan seluler, dan kemampuan untuk beralih ke tema gelap untuk tampilan malam hari.

Kemudian, pada 2015, Thibaut menjadikan DevDocs berfungsi penuh secara offline. Tiba-tiba, siapa pun dapat mengunduh seluruh rangkaian dokumentasi untuk akses offline. Semua file ini akan disimpan di browser, berkat penggunaan cerdas teknologi baru yang disebut IndexedDB.

Dan di awal 2016, Thibaut menambahkan dukungan untuk pembuatan versi. Alih-alih dibatasi hanya untuk versi terbaru dari sebuah dokumentasi, DevDocs sekarang mulai mendukung beberapa versi untuk setiap proyek dan pustaka.

Dua fitur baru utama tersebut akan menjadi titik perubahan di basis pengguna DevDocs. Proyek ini berkembang menjadi salah satu alat yang paling banyak digunakan di komunitas pengembang.

Jika Anda ingin melihat seberapa jauh DevDocs dalam lima tahun terakhir, bandingkan dua utas Berita Peretas ini:

  1. Utas pertama dari Juni 2013 - kebanyakan orang tidak suka membandingkan DevDocs dengan proyek dokumentasi lain (banyak di antaranya sekarang sudah tidak berfungsi).
  2. Utas kedua dari akhir 2017 - di salah satu utas yang paling banyak dipilih oleh Hacker News sepanjang masa, orang memuji DevDocs - terutama untuk kecepatannya. Pesannya jelas: proyek Anda tidak harus menjadi yang pertama dari jenisnya - Anda hanya harus mematuhinya dan membuat perbaikan yang konsisten, dan Anda dapat menjadi pemimpin.

Saat ini, lebih dari 100.000 pengembang menggunakan DevDocs sebagai referensi setiap bulan.

Bagaimana DevDocs bekerja di balik terpal

Salah satu pertanyaan paling umum yang ditanyakan orang pada Thibaut: bagaimana DevDocs bisa menjadi begitu cepat?

Thibaut mengaitkan kecepatan DevDocs dengan banyak faktor:

  • DevDocs adalah aplikasi web Ruby satu halaman dengan backend kecil.
  • Saat Anda mengunjungi DevDocs.io, setelah pemuatan halaman awal, semua file berikutnya (termasuk file dokumentasi) diambil melalui Jaringan Pengiriman Konten (CDN) secepat kilat.
  • Ini menggunakan GZIP, cache HTTP, Cache Aplikasi, JavaScript dan CSS yang digabungkan dan dikecilkan
  • Tidak ada iklan (iklan memperlambat semuanya)
  • Ini menggunakan localStorage sebagai tingkat tambahan caching untuk beberapa aset
  • Ini menggunakan cache memori untuk hal-hal seperti navigasi mundur dan maju instan
  • Ini menggunakan IndexedDB untuk menyimpan seluruh kumpulan dokumentasi secara lokal di komputer Anda
  • Dokumentasi dihapus dari semua aset jarak jauh dan markup yang tidak perlu, menghasilkan file yang lebih kecil
  • Ini menggunakan pencarian sisi klien yang dioptimalkan
  • Ini memiliki antarmuka pengguna non-pemblokiran dan asinkron
  • Ini menampilkan pohon DOM yang dioptimalkan dengan daftar bilah sisi halaman, sehingga tidak harus langsung merender 1.000 node
  • Ini memiliki antarmuka pengguna sederhana yang menghindari embel-embel seperti bayangan atau animasi

Terakhir, DevDocs tidak menggunakan jQuery atau kerangka kerja JavaScript apa pun. Semua operasi DOM diimplementasikan secara manual, membuatnya secepat yang mereka bisa. (Thibaut mengatakan dia tidak akan merekomendasikan pendekatan tanpa kerangka kerja ini untuk sebagian besar aplikasi, tetapi berfungsi dengan baik untuk DevDocs.)

Bagaimana Anda bisa terlibat

Saat ini kami sedang mencari pengembang Ruby yang bersemangat dan berpengalaman yang tertarik menjadi kontributor jangka panjang untuk DevDocs.

Kami juga mencari orang-orang yang tertarik untuk membuat DevDocs lebih mudah untuk berkontribusi, melalui penulisan dokumentasi dan kode refactoring.

Anda juga dapat membantu dengan melaporkan bug atau permintaan fitur yang Anda miliki di pelacak masalah, dan membantu melakukan triase atau memperbaikinya.

Anda dapat bergabung dengan ruang obrolan kontributor DevDocs di Gitter dan memperkenalkan diri Anda.

Terakhir, Anda dapat membantu dengan menggunakan DevDocs dan membagikannya dengan teman dan kolega Anda. Lain kali Anda perlu mencari dokumentasi, buka DevDocs.io.

Anda juga dapat mencari DevDocs dengan mengetikkan "devdocs" ke dalam bilah alamat Chrome dan menekan tab. Dan DuckDuckGo memiliki !ddperintah khusus untuk mencari DevDocs juga.

Bergabunglah dengan saya untuk menyambut Thibaut dan DevDocs ke komunitas freeCodeCamp dengan men-tweet padanya.

Selamat bersenang-senang, dan selamat membuat kode!