Улучшенная навигация по документации с новой боковой панелью

На этой неделе мы опубликовали значительное улучшение документации Discourse — новую боковую панель! Эта функция призвана сделать навигацию по нашей документации и доступ к ней ещё более простыми и интуитивно понятными, чем когда-либо прежде.

:star2: Что нового?

Новая боковая панель отображается во всех категориях и темах документации, облегчая навигацию по их содержимому. Вот что вы можете ожидать:

  1. Улучшенная навигация: Благодаря чёткой иерархической структуре переход между различными темами стал быстрее и проще.

  2. Осведомлённость о контексте: Боковая панель подсвечивает текущие просматриваемые темы, что позволяет легко понять, где вы находитесь в документации.

  3. Сворачиваемые разделы: Каждый раздел в боковой панели можно сворачивать и разворачивать по мере необходимости, что упрощает поиск нужных тем.

  4. Живой фильтр: Быстро находите конкретные темы в боковой панели, вводя соответствующие ключевые слова. Если ничего не найдено, вам будет предложено выполнить более глубокий поиск с тем же запросом.

  5. Адаптивность для мобильных устройств: Новая боковая панель безупречно работает на мобильных устройствах, предоставляя все те же функции, что и в десктопной версии.

:eyes: Давайте посмотрим

:boom: Вы уже сегодня можете увидеть новую боковую панель документации в действии!

Вот несколько скриншотов, чтобы лучше представить, чего ожидать:

Как видите, боковая панель предоставляет чёткий обзор всех разделов документации, делая навигацию лёгкой.

Каждая категория отображает темы внутри неё, разделённые на определённые разделы.

Тема, которую вы сейчас просматриваете, подсвечена в боковой панели для удобства.

Каждый раздел можно свернуть, что позволяет легче находить нужный контент.

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

:building_construction: Развитие недавних улучшений

Эта новая боковая панель является частью наших постоянных усилий по улучшению опыта работы с документацией Discourse. Она опирается на недавнюю работу по перестройке документации для повышения её понятности. Новая боковая панель дополняет эти структурные улучшения, предоставляя интуитивно понятный интерфейс для навигации по перекатегоризированной документации.

Это сочетается с ongoing переработкой контента всех тем нашей документации, чтобы привести его в соответствие с недавно опубликованным руководством по стилю. Эта работа находится в процессе, и вы можете заметить постепенные улучшения по мере её продвижения.

:ear: Мы хотим получить ваш отзыв!

У вас была возможность воспользоваться новой боковой панелью документации? Мы будем рады услышать ваше мнение! Пожалуйста, поделитесь своим опытом, предложениями или любыми вопросами в этой теме.

Если у вас есть вопросы или отзывы о наших общих усилиях в области документации, пожалуйста, сообщите нам в этой теме.

Спасибо, что вы являетесь частью сообщества Discourse. Мы с нетерпением ждём, как эта новая функция улучшит ваш опыт работы с Discourse.

22 лайка

Поздравляю с новыми изменениями, они действительно крутые. :clap:

  • Живая фильтрация по всем категориям
    Я понимаю, что текущий способ работы может быть неудобным; мне бы хотелось иметь возможность фильтровать, независимо от того, в какой (под)категории я нахожусь. Это первое, что я естественно попробовал:

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

  • Прокрутка контента вверх при использовании ctrl + /
    При использовании сочетания клавиш для фокусировки на поле ввода поиска прокручиваются вверх как боковая панель, так и контент. Я не ожидаю, что контент будет прокручиваться вверх в этом случае.

  • Потеря контекстной осведомленности
    Если вы используете фильтр, переходите к теме, а затем очищаете фильтр, вы можете не увидеть выделенную тему. РЕДАКТИРОВАНО: Также это происходит, если вы переходите к теме из сообщения.

  • Свернутый раздел не подсвечивается при просмотре темы
    Если вы просматриваете тему и сворачиваете разделы, я думаю, было бы полезно с точки зрения контекста как-то подсветить раздел или просто выделить его.

9 лайков

Отличное дополнение/улучшение! :tada:

Навигация стала гораздо проще, так как теперь гораздо очевиднее, куда смотреть :wink:

Есть лишь один небольшой момент: порядок категорий отличается от порядка в боковой панели навигации.

В Documentation последние три категории:

Documentation > Migrating to Discourse
Documentation > Contributing
Documentation > Developer Guides

Однако в боковой панели навигации Documentation > Developer Guides и Documentation > Contributing поменяны местами.

Отличная работа!

4 лайка

Они должны быть в том же порядке?

Где вы видите другой порядок?

1 лайк

Я на мобильном.

Как странно. Не знаю, почему у вас всё немного иначе. :thinking:

Вот что я вижу:

Кажется, у вас также отсутствует описание категории «Руководство для разработчиков» в поле. Вы, случайно, не отключили эту категорию или что-то в этом роде?

3 лайка

Могу ли я включить такой боковой панель категории на других экземплярах?

2 лайка

Это компонент темы #theme-component GitHub - discourse/discourse-docs-sidebar · GitHub.

5 лайков

Ах, вот оно что! Проблема решена! :wink:

5 лайков

Вы можете экспериментировать, но для того, чтобы мы были готовы полностью поддерживать это решение, предстоит ещё много работы.

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

Сейчас мы берём на себя эти затраты для поддержки документации здесь, сосредоточившись на сборе отзывов пользователей об опыте чтения и просмотра документации. В данный момент нас интересует именно такая обратная связь, а не мнения о том, каково это — поддерживать документацию с помощью этого компонента.

8 лайков

Действительно очень приятно. С нетерпением ждем полного релиза.

2 лайка

Это намного проще в использовании, чем старая версия. Более… понятно. Но могу поспорить, что более технически подкованные пользователи могут счесть это ограничивающим.

Я не использую документацию, даже когда в ней есть необходимость, потому что мои пользователи боятся фильтров. Эта система была бы более удобной для пользователя.

Но если она требует постоянного внимания и заботы со стороны администратора… :thinking:

3 лайка

Спасибо, что обратили на это внимание, @Arkshine! Все эти проблемы должны быть исправимы, поэтому мы посмотрим, что сможем сделать.

2 лайка

Непонятно, почему боковая панель документации меняет работу поиска. На моем планшете я не могу использовать клавишу Enter для получения результатов поиска, когда боковая панель документации видна. Я заметил, что там написано «Далее» вместо «Перейти», но не знаю почему.

Мне не удалось воспроизвести проблему.

Только что проверил на своём iPad.

Можешь проверить, сохраняется ли она?

Это всё ещё происходит. Я могу воспроизвести это в Chrome и Edge, но не в приложении Firefox.

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

Она не изменяет никакой код поиска.

Возможно, проблема в чём-то другом.

Можете предоставить больше подробностей о вашей конфигурации? Версия браузера, операционная система и т. д.

Galaxy Tab S9 FE
Android 14; SM-X510 Build/UP1A.231005.007
Chrome 126.0.6478.123

Я попробовал внешнюю клавиатуру. Это помогло мне определить, что клавишу Enter, apparently, нужно нажимать дважды.

2 лайка

Хорошо, я могу воспроизвести это на Android.

Проблема возникает не только в боковой панели документации, но и в боковой панели администратора.

Нам придётся расследовать эту проблему.

Я уже знаю, что происходит.

Мы обсудим наилучшее решение внутри команды.

4 лайка

Проблема должна быть решена следующим образом:

Это уже работает на Meta

5 лайков