Starting pages
It is good for your readers and for SEO to provide an overview of you documentation and separate sections. These overviews group the most useful and popular topics or those dedicated to a specific subject. You can also use it to provide a learning path for readers: where to begin, which topics are generic and which are more advanced or cover some specific subsystem.
To convert a topic to a starting page, add the <section-starting-page>
element to the root <topic>
element.
To create a new starting page topic, select the Section starting page template when creating a topic.
Here is an example of a starting page topic markup:
The <section-starting-page>
element has some predefined structure:
Use the
<spotlight>
element to provide links for two of the most important topics. Set thetype
to define what icon the spotlight card should have.Use the
<primary>
and<secondary>
elements to provide links for other important and useful topics.If necessary, use the
<misc>
element to provide links or cards to additional relevant topics.Add groups of
<links>
and<cards>
. For links, use the<group>
element to split them into groups of links.By default, additional miscellaneous groups are rendered in two columns. Add
narrow="true"
to a group if you want to render it in three narrow columns instead
Spotlight section type icons
academy
account
branch
bug
case
check-list
cloud
community
computer
container
creative
cross-check
cross-platform
cup
data
development
documents
experiment
file
filtering
folder
idea
install
integration
key
keyboard
learn
library
location
lock
mail
mixed
navigation
network
offer
open-source
presentation
search
server
settings
start
support
thumb-up
tools
top
turn-on
world