Docs page structure

Structure of a documentation page

All documentation pages must start with frontmatter as shown below.

---
title: SEO-Title-Browser-Tab-Title
headerTitle: Doc-Page-Title
linkTitle: Navigation-Link
description: SEO-Meta-Description
image: Icon-For-Page-Title
headcontent: Brief-description
menu:
  preview:
    identifier: page-identifier
    parent: parent-page-identifier
    weight: number-to-decide-display-order
type: docs
showRightNav: true
---

Mandatory frontmatter attributes

Field name	Description
`title`	Title text to display in browser tab and search engine results
`headerTitle`	Title text to appear as the page title
`linkTitle`	Title text to display in the navigation bar and breadcrumbs
`description`	Description text to display in search results
`headcontent`	Subtitle text below the headerTitle (index pages only)
`type`	Must be `docs` or `indexpage`. See types of pages.

Optional frontmatter attributes

Field name	Default	Description
`image`	N/A	Optional icon displayed next to the title (index pages only)
`showRightNav`	(depends)	Controls display of the TOC on the right. For pages of `type: docs`, default is true. For pages of `type: indexpage`, default is false.

Types of pages

There are two different types of documentation pages: index pages, and content pages.

Index pages have links to subtopics in a topic. These pages are generally named _index.html or _index.md.

Content pages contain information about topics. These pages are named in the format my-docs-page.md.