Document format checklist
Use this page to ensure your pull requests contain pages that are formatted correctly, removing basic errors prior to the review process.
If a pull request fails to meet any of the below, it should not be approved.
Newlines
One newline before and after each element
There is never any need to use two successive new lines (that is to say, two instances of the ENTER or carriage return key) when formatting Markdown files.
End each file with one newline
Some scripts and linters will check for files ending with a blank newline. To remove risk of scripts or linters failing, end each file with one blank newline.
Headings
Headings are the foundation of organizing content in a page. We already have a dedicated headings page, but review the below:
- H1 represents the top-level title of a page.
- H2 represents the overall sections of the page.
- H3 represents contextually related sections of an H2.
- H4 represents contextually related sections of an H3.
Do not use bold text instead of H3s or H4s.
Horizontal rules
Use horizontal rules to signify:
- The end of a H2 section.
- The end of a component parameter description.
- The end of a H3 section if you feel it is appropriate and adheres to internal document consistency.
Do not end a page with a horizontal rule.
Read Horizontal rules for more.
Tables
Format tables as per the tables document.