„DevDocs“ prisijungia prie „freeCodeCamp“ bendruomenės

„DevDocs“ yra atviro kodo žiniatinklio programa, sujungianti daugybės kūrėjų įrankių dokumentus į vieną sąsają, kurioje galima ieškoti.

Aš naudoju „DevDocs“ nuo tada, kai „freeCodeCamp“ net nebuvo, ir per daugelį metų giedojau jo pagyrimus.

„DevDocs“ greitis ir paprastumas yra tikras gaivaus oro gurkšnis. Kiekviena API išdėstyta toje pačioje aiškioje hierarchijoje.

Taigi, kai atėjo laikas kurti „freeCodeCamp Guide“ praėjusią vasarą, jau turėjau omenyje aiškų šabloną. Mes ketinome sukurti į „DevDocs“ panašią sąsają, skirtą programavimo koncepcijoms tirti.

Kreipiausi patarimo į „DevDocs“ kūrėją Thibaut Courouble. Jis buvo naudingas paaiškindamas, kaip „DevDocs“ veikė, ir motyvuodamas kai kuriuos savo dizaino sprendimus.

Jis ir aš palaikėme ryšį. Mes apsikeitėme idėjomis, kaip sukurti įrankius, kurie būtų lengviau prieinami kūrėjams kai kuriose pasaulio vietose be patikimo spartaus interneto ryšio.

Tada prieš porą mėnesių Thibautas kreipėsi į mane dėl galimybės paaukoti „DevDocs“ projektą „freeCodeCamp“ bendruomenei, kad galėtume toliau plėsti projektą už tai, ką jis sugeba padaryti kaip vienišas prižiūrėtojas.

Šiandien - praėjus lygiai 5 metams po to, kai „Thibaut“ sukūrė „DevDocs“ - džiaugiuosi galėdamas pranešti, kad „DevDocs“ dabar oficialiai priklauso „freeCodeCamp“ bendruomenei!

Trumpa „DevDocs“ istorija

Thibaut yra prancūzų kūrėjas, dabar dirbantis vyresniuoju plėtros vadovu „Shopify“ Otavoje, Kanadoje.

Thibaut sukūrė „DevDocs“ lygiai prieš 5 metus šiandien, 2013 m. Kovo 26 d. Tuo metu jis tiesiog norėjo geresnio būdo greitai pasiekti „Mozilla“ kūrėjų tinklo dokumentaciją.

Iš pradžių „DevDocs“ buvo tik įprastas dokumentacijos aplankas kietajame diske, asmeniniam naudojimui - toks, kokį daugelis kūrėjų turėjo po ranka. Tada, po kelių mėnesių plėtros, „Thibaut“ 2013 m. Birželio 18 d. Pristatė „DevDocs“ kaip nemokamą žiniatinklio programą.

Iš pradžių „Thibaut“ laikė „DevDocs“ uždarą kodą. Tačiau 2013 m. Spalio 24 d. Jis ją įsigijo.

Nuo tada „DevDocs“ projektas sukaupė daugiau nei 17 000 „GitHub“ žvaigždžių kartu su 66 bendraautoriais (nors „Thibaut“ vis dar yra pats produktyviausias bendradarbis).

„Thibaut“ parašė dešimtis grandymo scenarijų, kad galėtų išleisti ir automatiškai atsisiųsti įvairių projektų dokumentus, kurių kiekvienas kruopščiai sureguliuotas, kad sukurtų nuoseklią skaitymo patirtį ir sukurtų gerus paieškos rezultatus.

Per ateinančius dvejus metus „Thibaut“ pridėjo daug patobulinimų, tokių kaip nauja dokumentacija, spartieji klaviatūros klavišai, geresnė paieška, mobilusis palaikymas ir galimybė persijungti į tamsią temą naktiniam žiūrėjimui.

Tada 2015 m. „Thibaut“ padarė „DevDocs“ visiškai veikiantį neprisijungus. Staiga bet kas galėjo atsisiųsti visus dokumentų rinkinius, kad galėtų prisijungti neprisijungęs. Visi šie failai būtų saugomi naršyklėje, nes protingai naudojama nauja technologija, vadinama „IndexedDB“.

2016 m. Pradžioje „Thibaut“ pridėjo versijų palaikymą. Užuot apsiribojęs tik naujausia dokumentacijos versija, „DevDocs“ dabar pradėjo palaikyti kelias kiekvieno projekto ir bibliotekos versijas.

Šios dvi pagrindinės naujos funkcijos pasirodytų esančios „DevDocs“ vartotojų bazės tašku. Projektas išaugo ir tapo vienu plačiausiai naudojamų įrankių kūrėjų bendruomenėje.

Jei norite sužinoti, kiek „DevDocs“ pasiekė per pastaruosius penkerius metus, palyginkite šias dvi „Hacker News“ gijas:

  1. Pirmoji gija nuo 2013 m. Birželio mėn. - dažniausiai žmonės nepalankiai lygina „DevDocs“ su kitais dokumentacijos projektais (daugelis jų dabar neveikia).
  2. Antroji 2017 m. Pabaigos gija - vienoje iš visų laikų labiausiai įvertintų „Hacker News“ temų, žmonės giria „DevDocs“ - ypač už jo greitį. Pranešimas aiškus: jūsų projektas neturi būti pirmasis tokio pobūdžio - jūs tiesiog turite jo laikytis ir nuosekliai jį tobulinti, ir jūs galite tapti lyderiu.

Šiandien daugiau nei 100 000 kūrėjų kiekvieną mėnesį naudoja „DevDocs“.

Kaip „DevDocs“ veikia po gaubtu

Vienas iš labiausiai paplitusių klausimų, kuriuos žmonės užduoda Thibaut: kaip „DevDocs“ buvo toks greitas?

„Thibaut“ „DevDocs“ greitį sieja su daugeliu veiksnių:

  • „DevDocs“ yra vieno puslapio „Ruby“ žiniatinklio programa su maža vidine puse.
  • Kai lankotės DevDocs.io, po pradinio puslapio įkėlimo visi tolesni failai (įskaitant dokumentacijos failus) yra gaunami per žaibišką turinio pristatymo tinklą (CDN).
  • Jis naudoja GZIP, HTTP talpyklą, „App Cache“, sujungtą ir sutrumpintą „JavaScript“ ir CSS
  • Skelbimų nėra (skelbimai viską sulėtina)
  • Jis naudoja „localStorage“ kaip papildomą kai kurių išteklių talpyklos lygį
  • Ji naudoja atminties talpyklą tokiems dalykams kaip greita navigacija atgal ir atgal
  • Jis naudoja „IndexedDB“, kad išsaugotų visus dokumentų rinkinius jūsų kompiuteryje
  • Iš dokumentacijos atimamas visas nuotolinis turtas ir nereikalingas žymėjimas, todėl failai yra mažesni
  • Jis naudoja optimizuotą kliento paiešką
  • Ji turi neužblokuojančią ir asinchroninę vartotojo sąsają
  • Jame yra optimizuotas DOM medis su puslapių šoninės juostos sąrašu, kad nereikėtų iškart pateikti 1000 mazgų
  • Ji turi paprastą vartotojo sąsają, kuri vengia maivymosi, pavyzdžiui, šešėlių ar animacijos

Galiausiai „DevDocs“ nenaudoja jokių „jQuery“ ar jokių „JavaScript“ rėmų. Visos DOM operacijos yra vykdomos rankiniu būdu, todėl jos yra kuo greitesnės. (Thibautas sako, kad daugumai programų jis nerekomenduotų šio be pagrindų metodo, tačiau jis gerai veikia „DevDocs“.)

Kaip galite įsitraukti

Šiuo metu mes ieškome aistringo ir patyrusio „Ruby“ kūrėjo, kuris norėtų tapti ilgalaikiu „DevDocs“ bendradarbiu.

Mes taip pat ieškome žmonių, norinčių padėti „DevDocs“ lengviau prisidėti, rašant dokumentus ir atnaujinant kodą.

Taip pat galite padėti pranešdami apie visas klaidas ar funkcijų užklausas, kurias turite problemų stebėjimo priemonėje, ir padėdami jas išsiaiškinti ar ištaisyti.

Galite prisijungti prie „Devitter“ bendraautorių pokalbių kambario „Gitter“ ir prisistatyti.

Galiausiai galite padėti naudodami „DevDocs“ ir pasidalindami ja su draugais bei kolegomis. Kitą kartą, kai jums reikės ieškoti dokumentų, eikite į DevDocs.io.

Taip pat galite ieškoti „DevDocs“ naudodami „Chrome“ adreso juostoje įvesdami „devdocs“ ir paspausdami skirtuką. „DuckDuckGo“ turi specialią !ddkomandą ieškoti ir „DevDocs“.

Prisijunkite prie manęs ir sveikindami „Thibaut“ bei „DevDocs“ su „freeCodeCamp“ bendruomene, rašydami jam tweetingu.

Smagaus ir laimingo kodavimo!