Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(): remove internal links in docs #3591

Merged
merged 7 commits into from
Jan 31, 2025

Conversation

SchwJ
Copy link
Member

@SchwJ SchwJ commented Jan 27, 2025

Проблема

  1. Ссылки с одной страницы доки на другую не работали
  2. Ссылки в тулбаре вели на несуществующие страницы

Решение

1.1 Удалила такие ссылки, ведущие из одного пакета в другой
1.2 Переписала внутрипакетные ссылки в mdx в обоих пакетах
1.3 ! НЕ удалось добавить ссылки в описание компонентов, берущееся из комментариев в .tsx. Ссылки можно сделать, если перенести описание компонентов непосредственно в .mdx. Это можно сделать после отказа от старой доки

  1. Переписала ссылки в тулбаре на linkTo из addon-links

Чек-лист перед запросом ревью

  1. Добавлены тесты на все изменения
    ⬜ unit-тесты для логики
    ⬜ скриншоты для верстки и кросс-браузерности
    ✅ нерелевантно

  2. Добавлена (обновлена) документация
    ⬜ styleguidist для пропов и примеров использования компонентов
    ⬜ jsdoc для утилит и хелперов
    ⬜ комментарии для неочевидных мест в коде
    ⬜ прочие инструкции (README.md, contributing.md и др.)
    ✅ нерелевантно

  3. Изменения корректно типизированы
    ⬜ без использования any (см. PR 2856)
    ✅ нерелевантно

  4. Прочее
    ✅ все тесты и линтеры на CI проходят
    ✅ в коде нет лишних изменений
    ✅ заголовок PR кратко и доступно отражает суть изменений (он попадет в changelog)

@SchwJ SchwJ changed the title chore(): update live addon version and remove internal links in docs chore(): remove internal links in docs Jan 27, 2025
@zhzz zhzz merged commit 81b4b52 into next Jan 31, 2025
7 checks passed
@zhzz zhzz deleted the update-live-addon-version-in-packages branch January 31, 2025 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants