tgoop.com/kotlin_adept/109
Last Update:
Самая странная документация
Я, конечно, видел многое: когда у open-source библиотек документация отсутствовала совсем, была неполной или, наоборот, даже имела свой сайт с кучей классных примеров.
Но тут я столкнулся с gradle-плагином KMMBridge от известных ребят из Touchlab. Плагин предназначен для публикации KMP-фреймворка и его подключения через CocoaPods или SPM в iOS-проекте.
Итак, на GitHub никакой документации нет — всё на сайте, что, в целом, хорошо, идём туда. Прошерстив сайт, я понял, что это единственный плагин, в котором не написано, как его подключать. Как думаете, есть ли там информация о gradle-тасках, которые регистрирует плагин? Ответ очевиден
Тут может возникнуть логичный вопрос: а что вообще есть?
Они предлагают создать GitHub-проект из шаблона, где всё за тебя настроят, включая GitHub Actions
Супер странное решение, как будто все будут стартовать проект с этого плагина. Ага, конечно.
В итоге пришлось разбираться в шаблоне и исходном коде плагина, чтобы понять, как его использовать. И всё равно пришлось делать форк, так как они не предусмотрели возможность менять endpoint при загрузке в S3-хранилище.
В целом, плагин довольно полезный: с ним можно удобно шарить общий код с iOS, находясь в разных репозиториях. Но такой подход к документации явно может отпугнуть большинство пользователей.
А от какой документации вы кринжанули больше всего?
