A DevDocs csatlakozik a freeCodeCamp közösséghez

A DevDocs egy nyílt forráskódú webalkalmazás, amely számos fejlesztői eszköz dokumentációját egyesíti egyetlen kereshető felületen.

Azóta használom a DevDocs-ot, hogy a freeCodeCamp még létezett volna, és az évek során dicséretét énekeltem.

A DevDocs sebessége és egyszerűsége igazi friss levegő leheletet jelent. Minden API ugyanabban a világos hierarchiában van elhelyezve.

Tehát amikor eljött az ideje az freeCodeCamp Guide megtervezésének tavaly nyáron, már világos sablont gondoltam. Létrehoztunk egy DevDocs-szerű felületet a programozási koncepciók feltárására.

Tanácsért kerestem meg a DevDocs alkotóját, Thibaut Courouble-t. Hasznos volt a DevDocs működésének elmagyarázásában, valamint néhány tervezési döntésének indokolásában.

Ő és én folyamatosan tartottuk a kapcsolatot. Ötleteket cseréltünk egymással arról, hogyan lehetne megbízható nagysebességű internetkapcsolat nélkül olyan eszközöket készíteni, amelyek a világ egyes részein elérhetőbbek a fejlesztők számára.

Aztán pár hónappal ezelőtt Thibaut megkeresett tőlem a DevDocs projekt adományozásának lehetőségét az freeCodeCamp közösségnek, hogy tovább tudjuk fejleszteni a projektet azon túl, amit egyedüli fenntartóként képes megtenni.

És ma - pontosan 5 évvel azután, hogy Thibaut létrehozta a DevDocs-ot - örömmel jelentem be, hogy a DevDocs immár hivatalosan is a freeCodeCamp közösség része!

A DevDocs rövid története

Thibaut francia fejlesztő, aki jelenleg vezető fejlesztési vezetőként dolgozik a kanadai Ottawában, a Shopify-ban.

Thibaut pontosan 5 évvel ezelőtt, 2013. március 26-án hozta létre a DevDocs-ot. Akkoriban csak egy jobb módot szeretett volna elérni a Mozilla Developer Network dokumentációjához.

Eredetileg a DevDocs csak egy közönséges dokumentációs mappa volt a merevlemezén, saját személyes használatra - olyan, amellyel sok fejlesztő rendelkezett referenciaként. Ezután néhány hónapos fejlesztés után a Thibaut 2013. június 18-án elindította a DevDocs alkalmazást ingyenes internetes alkalmazásként.

Eleinte Thibaut zárt forráskódban tartotta a DevDocs programot. De 2013. október 24-én nyílt forráskódú volt.

A DevDocs projekt azóta több mint 17 000 GitHub csillagot gyűjtött össze, 66 hozzászólóval együtt (bár a Thibaut még mindig messze a legeredményesebb közreműködője).

Thibaut tucatnyi kaparós szkriptet írt, hogy kiadhassa és automatikusan letöltse dokumentációit a különböző projektekből, mindegyiket gondosan összehangolva, hogy következetes olvasási élményt teremtsen és jó keresési eredményeket generáljon.

A következő két évben a Thibaut számos fejlesztést adott hozzá, úgymint új dokumentációt, billentyűparancsokat, jobb keresést, mobil támogatást és az éjszakai megtekintéshez sötét témára való áttérés lehetőségét.

Aztán 2015-ben a Thibaut teljesen működőképessé tette a DevDocs-ot offline állapotban. Hirtelen bárki letölthetett teljes dokumentációkészletet offline elérés céljából. Ezeket a fájlokat a böngésző tárolja, köszönhetően az IndexedDB nevű új technológia okos használatának.

2016 elején pedig Thibaut támogatást adott a verziókhoz. Ahelyett, hogy csak a dokumentáció legfrissebb verziójára korlátozódna, a DevDocs mostantól kezdve több verziót is támogatott minden projekthez és könyvtárhoz.

Ez a két fő új szolgáltatás inflexiós pontnak bizonyul a DevDocs felhasználói bázisában. A projekt a fejlesztői közösség egyik legszélesebb körben használt eszközévé nőtte ki magát.

Ha meg szeretné tudni, milyen messzire jutott a DevDocs az elmúlt öt évben, hasonlítsa össze ezt a két Hacker News szálat:

  1. Az első szál 2013 júniusától - többnyire az emberek kedvezőtlenül hasonlítják össze a DevDocs-ot más dokumentációs projektekkel (amelyek közül sok ma már nem működik).
  2. A 2017 végének második szála - a Hacker News minden idők egyik legnépszerűbb szálában az emberek dicsérik a DevDocs-ot - különösen a sebessége miatt. Az üzenet világos: a projektjének nem kell elsőnek lennie a maga nemében - csak ragaszkodnia kell hozzá, és következetes fejlesztéseket kell végrehajtania rajta, és kijelölheti a vezetőt.

Ma már több mint 100 000 fejlesztő használja a DevDocs-t referenciaként havonta.

Hogyan működik a DevDocs a motorháztető alatt

Az egyik leggyakoribb kérdés, amelyet az emberek feltesznek Thibaut-nak: hogyan lett a DevDocs ilyen gyors?

A Thibaut a DevDocs sebességét számos tényezőnek tulajdonítja:

  • A DevDocs egyoldalas Ruby webalkalmazás, apró háttérképpel.
  • Amikor a DevDocs.io webhelyre látogat, a kezdeti oldalbetöltés után az összes következő fájl (beleértve a dokumentációs fájlokat is) villámgyors tartalomszolgáltató hálózaton (CDN) keresztül lesz letöltve.
  • GZIP-t, HTTP-gyorsítótárat, App Cache-t, összefűzött és tömörített JavaScript-et és CSS-t használ
  • Nincsenek hirdetések (a hirdetések mindent lelassítanak)
  • A localStorage-ot egyes elemek gyorsítótárának extra szintjeként használja
  • A memória gyorsítótárában olyan dolgokat használ, mint az azonnali visszafelé és előre navigáció
  • Az IndexedDB-t használja a teljes dokumentációkészlet gyorsítótárazásához lokálisan a számítógépen
  • A dokumentációtól eltávolítják az összes távoli eszközt és felesleges jelöléseket, ami kisebb fájlokat eredményez
  • Optimalizált ügyféloldali keresést használ
  • Nem blokkoló és aszinkron felhasználói felülettel rendelkezik
  • Optimalizált DOM-fát tartalmaz oldalazott oldalsáv-listával, hogy ne kelljen azonnal 1000 csomópontot megjelenítenie
  • Egyszerű felhasználói felülettel rendelkezik, amely elkerüli a sallangokat, mint az árnyékok vagy az animációk

Végül a DevDocs nem használ semmilyen jQuery vagy JavaScript keretrendszert. Az összes DOM műveletet manuálisan hajtják végre, amilyen gyorsan csak tudják. (Thibaut azt mondja, hogy a legtöbb alkalmazáshoz nem javasolná ezt a keretrendszer nélküli megközelítést, de a DevDocs esetében jól működik.)

Hogyan lehet bekapcsolódni

Jelenleg egy szenvedélyes és tapasztalt Ruby fejlesztőt keresünk, aki érdekelt abban, hogy a DevDocs hosszú távú munkatársa lehessen.

Olyan embereket is keresünk, akik érdekeltek abban, hogy a DevDocs-hoz könnyebben hozzá lehessen járulni, a dokumentumok megírásával és a kód visszaszerzésével.

Segíthet azáltal is, hogy jelentést tesz a hibakeresőben található hibákról vagy funkciókérelmekről, és segítséget nyújt ezek osztályozásában vagy kijavításában.

Csatlakozhat a DevDocs közreműködő csevegőszobájához a Gitteren, és bemutatkozhat.

Végül segíthet a DevDocs használatával, és megoszthatja azokat barátaival és kollégáival. Ha legközelebb dokumentációt szeretne keresni, keresse fel a DevDocs.io webhelyet.

A DevDocs-ban is kereshet, ha beírja a „devdocs” szót a Chrome címsorába, és megnyomja a lapot. És a DuckDuckGo-nak van egy speciális !ddparancsa a DevDocs-ban történő keresésre is.

Csatlakozzon hozzám, hogy tweetelve üdvözöljem Thibautot és DevDocs-ot a freeCodeCamp közösségben.

Jó szórakozást és boldog kódolást!