Use the checklist below to diagnose common formatting or rendering issues in your documentation.
Confirm the page is added to SUMMARY.md.
Check indentation levels in SUMMARY.md.
Ensure the filename and path are correct (case-sensitive).
Verify the target file exists.
Check that the file path is correct (e.g., ../folder/page.md).
Ensure section links match headings exactly (e.g., #section-name).
Confirm the image is inside the assets folder.
Check that the file name uses lowercase and contains no spaces.
Ensure the relative path is correct based on the page location.
Make sure all pipe characters (|) are aligned.
Verify each row has the same number of columns.
Ensure triple backticks (``` ) are correctly opened and closed.
Use language tags only when needed (e.g., json, xml).
Remove unnecessary blank lines.
Follow correct heading hierarchy (H1 → H2 → H3).
Ensure headings are unique.
Avoid using special characters in heading titles.
Last updated
