Starting pages can be used to create an overview of the section or the whole help instance and navigate a user through it. You can group multiple topics dedicated to a specific subject under such page.
They provide design and markup for highlighting the most useful and popular topics of a section or instance.
Also, they are a better alternative to wrapper topics since they are not empty, which is good for SEO.
For consistency reasons, starting pages have a fixed layout. For predefined groups, you can change the number of cards and their content. You can also add custom card and link groups and adjust their width.
Create a starting page
To create an empty starting page, create a topic and add the
section-starting-pagetag as a child of the
To create a starting page already filled with all the possible elements, which you can then remove or edit as you want, start creating a topic from a template and select Section starting page template type.
Starting page structure
section-starting-page content structure can look like this:
secondary groups are mandatory,
misc are optional.
spotlight must contain exactly two links with icons.
Since on starting pages a certain structure is expected, we provide you a template containing all the elements, so you can create a starting page from template, add links to topics and remove everything you don't need.
Links on a starting page have to be divided into groups.
spotlight tag to highlight the most useful and popular topics of a section. The
type attribute defines the card's icon.
Place other important topics in the
secondary groups. These groups are mandatory.
If necessary, use the
misc section to add more relevant cards or links.
Add other relevant cards or links
misctag, add either
titletag or attribute.
links, wrap each set of links with the
grouptag and add a title for each group.
Define links to relevant topics.
If necessary, specify the width of groups.
narrow="true"to a group if you want to render three narrow columns. By default, it is
false, and groups are rendered in two columns.