[vkui.io] комментарии, предложения, замечания

[inomdzhon]

Note

Анонсируем черновик новой документации, которую залили на новый домен https://vkui.io 💅

🚀 Вот что пересмотрели

• Разделили Быстрый старт на 2 отдельные страницы Установка и Использование, убрав всё лишнее.
• Переписали документации Адаптивность и Cерверный рендеринг.
• В разделе Компоненты изменили группировку и пересмотрели категории.
• Наполнили документации компонентов.
• Переделали Playground компонентов.

🔄 Что в процессе (проблемы, о которых знаем)

• Приведение стилистики текста к единому виду и корректировка документации компонентов – документацию писали в несколько рук, поэтому есть расхождения.
• Добавление вкладки с API на страницах компонентов.
• Подгонка вёрстки под конечный дизайн.
• Правка шаблоны для Vite и NextJS под описанное из Установка.
• Playground
  • реализация адаптивной версии для мобильных экранов.
  • кнопка сброса.
• Развитие страницы с блогом.
• Создание главной страницы.

☎️ обратная связь

Сейчас цель анонса поделиться промежуточным результатом. Хотим получить обратную связь на берегу, прежде всего по содержанию, например, раздела Начала работы. Для этого создали эту дискуссию.

Баги можно отмечать в PR #8598.

Заранее спасибо 🫰

[scffs]

В разделе Компоненты изменили группировку и пересмотрели категории.

Неудобно, что сабкатегории / подкатегории нельзя свернуть

[inomdzhon]

Хочется, чтобы они сразу были свёрнуты при открытии раздела?

[scffs]

Хочется, чтобы они сразу были свёрнуты при открытии раздела?

Да

[inomdzhon]

Вместо сворачивания вернули поле поиска по разделу #8667 (comment)

[irdkwmnsb]

Очень не хватает поиска по компонентам. Есть поиск глобальный, но я хочу найти только компонент

[inomdzhon]

✅

[irdkwmnsb]

Очень хочется чтобы когда я открывал компонент - панель слева скорллилась до выбранного компонента

[inomdzhon]

✅

[irdkwmnsb]

Не хватает открытого примера кода для каждого компонента.
Каждый раз забываю что для этого нужно нажать на кнопку.
Но то что теперь примеры стали понятнее и проще - лайк.

[inomdzhon]

Примеры в основной документации нацелены больше на визуальное представление, поэтому сам код в новой документации скрыли. До этого пример был в конце страницы и там можно было в целом сразу раскрывать код – сейчас мы сделали более точечные мини-примеры и открытый код размывает фокус.

Сравнение

[irdkwmnsb]

https://vkui.io/components/typography#overview
Если есть библиотека компонентов - я бы ожидал что при нажатии на компонент перебрасывало на страницу с этим компонентом

[BlackySoul]

https://vkui.io/components/typography#overview Если есть библиотека компонентов - я бы ожидал что при нажатии на компонент перебрасывало на страницу с этим компонентом

Предполагалось, что все типографические элементы будут в рамках этой страницы. Подумаем, как сделать это более очевидным.

[inomdzhon]

✅ сделали блоки якорями, чтобы к ним можно было по ссылке попасть

[irdkwmnsb]

https://arc.net/l/quote/hdyjklwz ведет на 404

[scffs]

разве

[BlackySoul]

Имеется в виду, что сами Text, Headline ведут на сломанную линку

[irdkwmnsb]

https://arc.net/l/quote/bbscxpww
И это тоже ведет на 404

[inomdzhon]

✅

[irdkwmnsb]

https://arc.net/l/quote/zocsxbep
А работает ли песочница?

[inomdzhon]

Зальём сегодня/завтра, пока тестово раскатили другие изменения, кнопки на песочницу тоже залетели, но пока не рабочие, да

[inomdzhon]

✅

[papay88]

Приветствую, вопрос не много не по теме, а что вы за движок используете для доки на vkui.io, docusaurus, другой или свое решение?

[SevereCloud]

Привет, для документации на vkui.io сейчас используется Nextra на базе Next.js с кастомной темой которая написана с нуля. Код сайта находится в папке website, кастомная тема в папке packages/vkui-docs-theme

Также используем:

• Pagefind для полнотекстового поиска
• react-live для интерактивных playground-примеров кода.

[papay88]

Спасибо вам за этот развернутый ответ.