Обсуждение «стоит ли использовать вики или папку docs на GitHub?» всплывает каждые несколько месяцев. Следуя правилу трех страйков Шона Ванга, автор утверждает, что использование вики на GitHub — это антипаттерн. Единственным преимуществом вики является его постоянная доступность, но в нем отсутствуют версионирование, локальный доступ, ревью кода и возможности брендинга. В отличие от этого, папка /docs интегрирует документацию с кодом, поддерживает версионирование, включает ревью пулл-реквестов и работает с такими инструментами, как Vale и проверка орфографии. Изображения должны размещаться в другом месте, так как вики не поддерживает загрузки. Для публикации документации используйте папку /docs с GitHub Pages и темой вроде just-the-docs. Избегайте ветки gh-pages, чтобы документация версионировалась вместе с кодом. По мере роста проектов документация может переехать в отдельный репозиторий, но контрибьюторы уже будут привыкшие к рабочему процессу. Автор призывает к обратной связи в Twitter.