DevDocs присоединяется к сообществу freeCodeCamp

1656651017 devdocs prisoedinyaetsya k soobshhestvu freecodecamp

DevDocs — это веб-приложение с открытым кодом, объединяющее документацию для многих инструментов разработчика в единый интерфейс с возможностью поиска.

Я использую DevDocs еще до того, как freeCodeCamp вообще существовал и в течение многих лет пел ему дифирамбы.

5I5NnL3Is1K70JuVme3DZIpQwVQr0nBSG5bF
Простая целевая страница DevDocs с доступной для просмотра документацией API слева

Скорость и простота DevDocs – настоящий глоток свежего воздуха. Каждый API изложен в одинаковой четкой иерархии.

QkN3JS9RXTkAQzCtl5VBOkgcH9VfPnMV3SGp
Снимок экрана DevDocs.io и его интуитивно понятный интерфейс просмотра документации API

Когда прошлым летом пришло время разработать руководство по freeCodeCamp, я уже имел в виду четкий шаблон. Мы собирались создать интерфейс, похожий на DevDocs для изучения концепций программирования.

Я обратился за советом к создателю DevDocs Тибо Курубля. Он был полезен, объяснив, как работает DevDocs, и объяснял, как он доказал некоторые свои дизайнерские решения.

UydWCEFCDVcOv23vnbA9EhMEpZj6q5dJX-rL
Создатель DevDocs Тибо Курубл

Мы с ним поддерживали связь. Мы обменялись идеями о том, как сделать инструменты, которые были бы более доступны для разработчиков в частях мира без надежного высокоскоростного подключения к Интернету.

Тогда пару месяцев назад Тибо обратился ко мне с предложением пожертвовать проект DevDocs сообществу freeCodeCamp, чтобы мы могли продолжать развивать проект сверх того, что он может делать как одинокий сопровождающий.

И сегодня – ровно через 5 лет после того, как Тибо создал DevDocs – я рад объявить, что DevDocs теперь официально является частью сообщества freeCodeCamp!

Краткая история DevDocs

Тибо – французский разработчик, который сейчас работает старшим руководителем разработки в Shopify в Оттаве, Канада.

Тибо создал DevDocs ровно пять лет назад, сегодня, 26 марта 2013 года. Тогда он просто желал лучший способ быстрого доступа к документации Mozilla Developer Network.

Сначала DevDocs была просто обычной папкой с документацией на его жестком диске для его личного пользования – такой, которую многие разработчики имели под рукой для справки. Затем, после нескольких месяцев разработки, Тибо запустил DevDocs 18 июня 2013 как бесплатную веб-программу.

Сначала Тибо держал DevDocs закрытым кодом. Но 24 октября 2013 он открыл исходный код.

С тех пор проект DevDocs собрал более 17 000 звезд GitHub вместе с 66 участниками (хотя Тибо все еще остается плодотворным участником).

IME5se6-AC5zmQLYEJFRn0wnA85lwGLaVwU8

Тибо написал десятки скрапинг-сценариев для автоматической загрузки документации из разных проектов, каждый из которых был тщательно сконфигурирован, чтобы создать последовательный опыт чтения и получить хорошие результаты поиска.

В последующие два года Тибо добавил много усовершенствований, таких как новая документация, комбинации клавиш, улучшенный поиск, поддержка мобильных устройств и возможность переключаться на темную тему для просмотра ночью.

Затем, в 2015 году, Тибо сделал DevDocs полнофункциональным оффлайном. Вдруг кто-либо мог загрузить целые комплекты документации для доступа в автономном режиме. Все эти файлы будут храниться в браузере благодаря разумному использованию новой технологии под названием IndexedDB.

А в начале 2016 Thibaut добавил поддержку управления версиями. Вместо того чтобы ограничиваться только последней версией документации, DevDocs теперь начал поддерживать несколько версий для каждого проекта и библиотеки.

Эти две основные функции станут точкой перелома в базе пользователей DevDocs. Проект стал одним из наиболее широко используемых инструментов в сообществе разработчиков.

SSf07mo9M2H0eJYYZM5t8XIppq0euoGtAH3L
Параметры офлайн-режима DevDocs можно увидеть здесь с включенным темным режимом.

Если вы хотите увидеть, как далеко продвинулся DevDocs за последние пять лет, сравните эти две темы Hacker News:

  1. Первая тема с июня 2013 года – преимущественно люди, неодобрительно сравнивающие DevDocs с другими документационными проектами (многие из которых уже не существуют).
  2. Вторая тема с конца 2017 года – в одной из самых популярных тем всех времен Hacker News люди хвалят DevDocs – в частности, за ее скорость. Сообщение четкое: ваш проект не обязательно должен быть первым в своем роде — вам просто нужно придерживаться и постоянно совершенствовать его, и вы сможете стать лидером.

Сегодня более 100 000 разработчиков ежемесячно используют DevDocs в качестве справочного материала.

Как DevDocs работает под капотом

Один из самых распространенных вопросов, которые люди задают Тибо: как DevDocs стал таким быстрым?

Тибо объясняет скорость DevDocs многими факторами:

  • DevDocs — это одностраничная веб-приложение Ruby с небольшой серверной частью.
  • При посещении DevDocs.io после начальной загрузки страницы все последующие файлы (включая файлы документации) загружаются через молниеносную сеть доставки содержимого (CDN).
  • Он использует GZIP, кэширование HTTP, кэш приложений, объединенный и минимизированный JavaScript и CSS
  • Рекламы нет (реклама все замедляет)
  • Он использует localStorage в качестве дополнительного уровня кэширования для некоторых ресурсов.
  • Он использует кэш-память для таких вещей, как мгновенная навигация назад и вперед
  • Он использует IndexedDB для кэширования целых наборов документации локально на вашем компьютере
  • Документация лишена всех удаленных активов и ненужной разметки, что приводит к меньшим файлам.
  • Он использует оптимизированный поиск на стороне клиента
  • Он имеет неблокирующий и асинхронный пользовательский интерфейс
  • Он содержит оптимизированное дерево DOM с разбитым на страницы списком на боковой панели, поэтому ему не нужно сразу отображать 1000 узлов.
  • Он имеет простой пользовательский интерфейс, избегающий таких излишеств, как тени или анимация.

Наконец, DevDocs не использует никаких jQuery или фреймворков JavaScript. Все операции DOM выполняются вручную, что делает их максимально быстрыми. (Тибо говорит, что он не рекомендовал бы этот подход без фреймворков для большинства программ, но он хорошо работает для DevDocs.)

Как вы можете принять участие

Мы ищем страстного и опытного разработчика Ruby, который заинтересован в том, чтобы стать долгосрочным соавтором DevDocs.

Мы также ищем людей, заинтересованных в облегчении работы с DevDocs путем написания документации и рефакторинга кода.

Вы также можете помочь, сообщая о любых ошибках или запросах на функции, которые вы имеете в системе отслеживания проблем, и помогая сортировать или исправлять их.

Вы можете присоединиться к чату участников DevDocs на Gitter и представиться.

Наконец, вы можете помочь, воспользовавшись DevDocs и поделившись с друзьями и коллегами. В следующий раз, когда вам понадобится поиск документации, перейдите на DevDocs.io.

Вы также можете искать DevDocs, введя «devdocs» в адресную строку Chrome и щелкнув вкладку. И DuckDuckGo имеет особый вариант !dd также для поиска DevDocs.

Присоединяйтесь ко мне, чтобы приветствовать Тибо и DevDocs в сообществе freeCodeCamp, написав ему твит.

Приятного вам кодирования!

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *