docs(): create new documentation #3469
Open
Conversation
This file contains 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
SchwJ
force-pushed
the
mdx-exaples-on-storybook-7
branch
from
122f63f
to
bd2e6b4
Compare
SchwJ
force-pushed
the
mdx-exaples-on-storybook-7
branch
from
ec01d0e
to
e0bcf4d
Compare
chore(): add validation docs files
…ok-7 # Conflicts: # packages/react-ui/.storybook/preview.tsx # packages/react-ui/components/Button/__stories__/Button.stories.tsx # packages/react-ui/components/ComboBox/ComboBox.tsx # packages/react-ui/components/CurrencyLabel/CurrencyLabel.tsx # packages/react-ui/components/DateInput/DateInput.tsx # packages/react-ui/components/Dropdown/Dropdown.tsx # packages/react-ui/components/MenuFooter/MenuFooter.tsx # packages/react-ui/components/MenuHeader/MenuHeader.tsx # packages/react-ui/components/Paging/Paging.tsx # packages/react-ui/components/ScrollContainer/ScrollContainer.tsx # packages/react-ui/components/Toggle/Toggle.tsx # packages/react-ui/components/TokenInput/TokenInput.tsx
SchwJ
force-pushed
the
mdx-exaples-on-storybook-7
branch
from
f76716a
to
837b7b0
Compare
…ok-7 # Conflicts: # packages/react-ui/components/Button/Button.md # packages/react-ui/components/Button/Button.tsx # packages/react-ui/components/Link/Link.md # packages/react-ui/components/Link/Link.tsx # packages/react-ui/components/MaskedInput/MaskedInput.md # packages/react-ui/components/MaskedInput/MaskedInput.tsx # packages/react-ui/components/MaskedInput/__stories__/MaskedInput.stories.tsx
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.
Проблема
Старая документация устарела и имеет ряд проблем.
Решение
Решено делать новую документацию на базе Storybook.
Текущий деплой здесь: https://ui.gitlab-pages.kontur.host/storybook-documentation/
Что реализовано:
1.1. Страница для компонента (содержание)
1.1.1. Обновлены описания компонентов
1.1.2. Добавлены ссылки на Гайды и Figma (где они есть)
1.1.3. Базовый пример контрола
1.1.4. Таблица пропов. Берутся также пропы компонента, от которого наследуемся. Обновлены описания пропов
1.1.5. Истории (примеры использования компонента). С возможностью посмотреть код.
1.2. Информационные страницы
1.2.1. Вынесены информационные страницы и отдельно страницы версионирования
1.2.2. Собрана Versions из старых версий (данные берутся из json и из задеплоенных версий в гитлабе)
1.3. Группировка в левом меню: компоненты разделены на логические группы, созданы группы версионирования и информационных страниц. Группы отсортированы в порядке, который мне кажется наиболее удобным.
1.4. Переключения локали, темы и фиче-флагов -- доступны только в дочернем сторибуке
1.5. Для каждой страницы собирается содержание
2.1. Страницы переведены на mdx
2.2. Примеры сделаны на страницах с помощью +
jsx static ..., чтобы была возможность и "потыкать" и код посмотреть. (Потому что при использовании одних Story нет возможности посмотреть код. Предположительно из-за фильтра для mdx в filteredStorybooksWebpackRules)2.3. Переключение фиче-флагов -- доступно только в дочернем сторибуке
3.1. Информационные страницы (вынесены из react-ui и переведены на mdx)
3.1.1. Accessibility
3.1.2. Contributing
3.1.3. Ecosystem
3.2. Подключены сторибуки React UI и React UI Validations
Ссылки
Чек-лист перед запросом ревью
Добавлены тесты на все изменения
⬜ unit-тесты для логики
✅ скриншоты для верстки и кросс-браузерности
⬜ нерелевантно
Добавлена (обновлена) документация
✅ styleguidist для пропов и примеров использования компонентов
✅ jsdoc для утилит и хелперов
⬜ комментарии для неочевидных мест в коде
✅ прочие инструкции (
README.md,contributing.mdи др.)⬜ нерелевантно
Изменения корректно типизированы
✅ без использования
any(см. PR2856)⬜ нерелевантно
Прочее
❌ все тесты и линтеры на CI проходят -- не проходят 4 теста MaskedInput
✅ в коде нет лишних изменений
✅ заголовок PR кратко и доступно отражает суть изменений (он попадет в changelog)