Представляем простой режим для категорий документации Discourse

Категории документации созданы для особого типа контента: справочных материалов, к которым читатели возвращаются, быстро просматривают и часто используют для ссылок. Чтобы поддержать это, мы внедряем новый простой режим для плагина Discourse Doc Categories, который обеспечивает для документации сфокусированный опыт чтения, при этом полная тема остаётся доступна в один клик.

Просмотр темы с приоритетом чтения

Когда включён простой режим, открытие темы документации выводит сам документ в центр внимания. Ответы остаются в одном клике, скрытые за переключателем в исходном посте (OP):

Показать 12 комментариев / Скрыть комментарии

Нажмите на него, и полное обсуждение появится на своём обычном месте, отсортированное и отформатированное точно так же, как всегда. Нажмите ещё раз, чтобы свернуть его.

Стоит отметить несколько деталей:

  • Прямая ссылка на ответ (/t/slug/id/4) автоматически разворачивает тему, поэтому любой, кто перейдёт по ссылке для обмена или уведомлению, окажется в посте, на который его направили.
  • Новые ответы, появившиеся во время свёрнутого состояния темы, учитываются в метке переключателя, так что вы сразу видите, когда появилось что-то новое.

Список тем, адаптированный под документацию

Внутри категории документации список тем также упрощён: столбцы сосредоточены на заголовке и дате последнего обновления, при этом столбец Activity отображается как Updated. Читатели могут быстро просматривать заголовки и сразу замечать свежие материалы.

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

Включение режима на вашем сайте

Простой режим поставляется как экспериментальное грядущее изменение. Перейдите на страницу грядущих изменений в панели администратора (/admin/config/upcoming-changes) и найдите Doc categories simple mode, чтобы активировать его.

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

Мы будем рады вашим отзывам

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

5 лайков