Какой должна быть главная страница для категорий документации?

Когда вы нажимаете на Documentation > Site Management, не кажется ли вам, что это должно перенаправлять вас на индекс, а не на последние темы?

Или, возможно, это должно вести к какой-то другой теме «обзора», которую вы укажете?

Ранее мы напрямую ссылались на индекс в описаниях категорий, чтобы сделать его более заметным:

связанное обсуждение

Или, возможно, всё в порядке как есть? Возможно, это избыточно, учитывая, что индекс уже находится в боковом меню, но мне кажется, что текущий дизайн вызывает некоторый дискомфорт по двум причинам:

  • сам индекс может быть трудно найти
  • список последних тем кажется немного дезориентирующим по сравнению с тем, как работает просмотр документации, когда вы уже находитесь в определённой теме
4 лайка

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

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

Может быть, правая боковая панель с более структурированным оглавлением, а не текущая узкая левая панель, сработает лучше?

3 лайка

Я тоже об этом думал, отдельно от meta.discourse.org, но как общую потребность для плагина категорий документации. Переход на главную страницу во многих случаях гораздо лучше, и, я думаю, это прояснит содержимое боковой панели для пользователей по сравнению с переходом непосредственно в категорию, где они, скорее всего, не заметят изменений в боковой панели, пока не откроют тему.

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

Я сегодня немного глубже изучил этот вопрос — я размышлял, стоит ли создать pull request для добавления настройки в плагин. При включении эта настройка заставляла бы прямые ссылки на категорию перенаправлять браузер на индекс документации для этой категории. Изучая существующую работу над плагином, я наткнулся на гораздо более масштабную переработку функций, которая сейчас находится в процессе: FEATURE: Add visual doc category index editor by megothss · Pull Request #87 · discourse/discourse-doc-categories · GitHub

Кажется, это отличное время для добавления такой опциональной функциональности, позволяющей использовать индекс документации в качестве списка категорий. В то же время это может вступить в конфликт с режимом «Простой» (Simple Mode), который @sam разрабатывает в рамках обновления. Сэм, видишь ли ты описанную мной опцию как что-то, что могло бы вписаться в твою работу над режимом «Простой» или в более масштабную работу в PR по предоставлению дополнительных вариантов построения индекса? Было бы действительно здорово иметь возможность выбирать упрощённую настройку столбцов, которую ты разрабатываешь, или просто использовать тему индекса. Возможно, в идеале содержимое поста отображалось бы выше полного, обычного или упрощённого списка категории.

1 лайк