Page Structure

Each documentation page must have stable headings configured by default. The headings are automatically generated as level 1 headings for the page when creating a documentation page or when adding the xobject of type DocApp.Code.DocumentationClass (if you are an advanced user). To follow this rule, make sure that when applying Diataxis, you also correctly complete the other fields that are provided by the documentation page structure:

• Content field: Put here the main documentation content for the page type. If additional headings are needed, place them under this heading, as level 2 headings or lower. Make sure you follow the Documentation Style for the content. 
• FAQ field: Use level 2 headings phrased as questions a user, admin, or developer might have while using the feature described in the doc page or while reading the page. Answers should be limited to 1–2 sentences, if a longer explanation is needed, create a dedicated explanation page instead. This field is optional. (Before this, in the old way of writing documentation pages, we used info boxes, but they were considered more disruptive). The maximum number of FAQ entries allowed is 5. If there are more than 5, you must create a separate documentation page for troubleshooting, otherwise, a documentation violation will be triggered.
• Highlights field: Highlights are a list of key pages (mandatory only when there are more than 15 pages in the LiveTable of the page).
• Related field: Add links to pages that cover the same subject but are not child pages of the current page. The children pages are already automatically configured to be displayed in the "More" when creating a documentation page.