Page Structure
Last modified by Vincent Massol on 2026/07/28 22:16
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. The maximum number of FAQ entries allowed is 5, and the FAQ content must not exceed 25 lines; if you need more, create a separate documentation page for troubleshooting, otherwise a documentation violation warning will be triggered.
- Highlights field: a short list of the page's most important child pages. See Highlights on a Page for when to fill it, the maximum, and the syntax.
- Related field: Add links to pages that cover the same subject but are not child pages of the current page. Child pages are automatically listed in the "More" section when you create a documentation page, so they do not belong here.