docs(bannerpro): добавить документацию компонента#919
Open
Ibochkarev wants to merge 2 commits into
Open
Conversation
Добавляет документацию BannerPro по актуальным исходникам пакета: вывод баннеров, настройки, админка, интеграции, события и REST API.
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
1 participant
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.
Связь с issue
—
Описание улучшений
Добавлена многостраничная документация BannerPro для docs.modx.pro: обзор, быстрый старт, системные настройки, админка, вывод на сайте, сниппет
BannerPro, интеграции с MiniShop3 и аналитикой, события MODX, REST API и FAQ.Документация сверена с актуальными исходниками пакета в
Extras/BannerPro: системные настройкиbannerpro_*, плагиныBannerProClickout,BannerProImpression,BannerProAnalytics,BannerProMiniShop3, параметры сниппета и read-only REST API. Все пользовательские примеры вызова и чанков даны в двух синтаксисах: Fenom и MODX.Добавлены EN-заглушки для новых страниц, чтобы у BannerPro были парные файлы в
docs/en/. Также обновлёнcspell.jsonтерминами компонента.Тип изменения (по желанию): новая страница/раздел · правки по компоненту/гайду
Актуальные проблемы
—
Чеклист перед отправкой
pnpm run lintиpnpm run spellcheck(или правки по замечаниям внесены).Локально проверено по BannerPro:
pnpm run lint -- docs/components/bannerpro/**/*.md docs/en/components/bannerpro/**/*.mdpnpm exec cspell --no-progress docs/components/bannerpro/**/*.md docs/en/components/bannerpro/**/*.md