Page Structure

Last modified by Eleni Cojocariu on 2026/08/12 15:17

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:

 FieldWhat it containsImage
ContentThe 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 ContentField.png
FAQLevel 2 headings phrased as questions that a user, administrator, or developer might have while using the documented feature or reading the page. Keep answers to 1–2 sentences. This field is optional. You can add a maximum of 5 FAQ entries, and the FAQ content must not exceed 25 lines. If more space is needed, create a separate documentation page for troubleshooting. Otherwise, a documentation violation warning will be triggered.  FAQField.png
HighlightsA short list of the page's most important child pages. See Highlights on a Page for when to fill this field, the maximum number of highlights, and the syntax.  HighlightedField.png
RelatedLinks 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, so do not add them here. If the page is a top-level page (its parent is a target/audience page, such as one under /user/, /admin/, or /dev), include links to top-level pages covering the same topic for other target audiences, when they exist. Use the format <topic name> (for <target>). For an example, see the Related section of Like. RelatedField.png

Get Connected