docs: README к выпуску FetchIt 4 и новый логотип - #35
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Зачем
К выпуску FetchIt 4 README должен с первого экрана объяснять, что это и зачем, а подробности раскладывать по разделам. Логотип перерисован в едином стиле, и теперь он рендерится из исходника, а не хранится готовой картинкой.
Что меняется
Логотип
.github/logo/logo.html: светло-серый квадрат с формой (два поля и кнопка вsky-500из Tailwind CSS 4), рядом надпись «Fetch» шрифтом Outfit и «It» шрифтом JetBrains Mono.npm run logoрендерит из него:logo.pngиlogo@2x.pngна прозрачном фоне для README;logo-dark.pngиlogo-dark@2x.pngсо светлой надписью для тёмной темы GitHub (README выбирает вариант через<picture>);social.png1280×640 для превью ссылок на репозиторий.Сборка
transform.targetвrolldown.config.ts). Вbrowserslistпроекта есть UC Browser и Opera Mobile на Chromium 78, который не разбирает?.,??и??=. Минифицированный скрипт вырос на 1,5 КБ, в gzip на 0,5 КБ.npm run check:syntaxпроверяет обе сборки парсером ES2019 (acorn), CI запускает её в задаче Frontend. Прежняя сборка эту проверку не проходит.README
readme.txtпакета, который показывает Менеджер пакетов, описание дописано и добавлена ссылка на README.Заметки для ревью
fetchit-logo.svgв корне я не удалял: на него могут ссылаться страницы пакета на modstore.pro, modx.com и в документации по адресу изmaster. Когда ссылки будут заменены, его можно убрать.social.pngнужно загрузить вручную: Settings, General, Social preview. У GitHub нет для этого API.detailи отмена каждого события, моментfetchit:reset, формы из AJAX, требования к браузерам и PHP, размеры скрипта, значения настроек. Описание хукаresetвfetchit.d.tsтоже поправлено.4.xстанетmaster, его нужно будет поправить.