Docs Structure Guide

Page Structure

The first header inside of any page should be an h2 header using ==Header==. Single = signs are reserved for the page title only.

Hierarchical organization

• Avoid unnecessary layers; they make documentation hard to find and hard to follow. For example, consider that in a book, the appendices are on the same level as "chapters" of the book.
• Avoid duplication; it is better to link to existing documentation about a topic, rather than duplicate it (or nearly duplicate it) in a second location. * Only H2 headers will appear in the Table of contents
• Use H3 headers for layout purposes and to break up your H2 sections Hierarchy example:

Page Title
==Overview==
==Using Function==
===Sub-Header===
===Example===
==Special circumstances==
===Case one===
===Case two===

In the list above the sub-header, examples and cases would not appear in the table of contents.