Use topic-based categories

Topic-based categories are a new, special category type that displays the full text of each article. Readers can view all its articles on a single page, reading it like a book or choosing which articles to read.

Example: User Management Guide

For example, you might have an FAQ page with 20 frequently asked questions and answers. If you set this up using a topic-based category, you would create the topic-based category and then create the 20 FAQs as 20 separate articles. 

When someone wants to read your FAQs, they can browse to the topic-based category and view all the FAQs in one place. However, when someone searches for one of the FAQs, the individual FAQ article comes up in search, giving them the answer immediately rather than sending them to the FAQ page and requiring them to browse to their question.

Besides FAQs, longer documentation with multiple steps or sections are often good candidates for topic-based categories. Some readers might want to view the full documentation in one place like a guide, whereas others might just need or want help with one section or step. Breaking up the documentation into separate articles in a topic-based categories allow people searching to get straight to the step or section they need while people who wants to view the documentation in full can use the topic-based category page. 

Topic-based categories:

  • Can only contain articles
  • Can be displayed accordion style, with each article collapsed below its title and clicking the title expands the content
  • Can have quick links, or a mini table of contents, at the top of the article that link to each article on the page