File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -101,7 +101,7 @@ When reviewing a pull request, verify the following:
101101
102102- [ ] Front matter block (`---`) is present and includes a `title` field.
103103- [ ] Page title in front matter matches the entry in `mkdocs.yml`.
104- - [ ] Heading hierarchy is correct (`#` (optional) → `# #` → `###` → `####`, no skipping levels).
104+ - [ ] Heading hierarchy is correct (`##` → `###` → `####`, no skipping levels).
105105- [ ] Admonitions use the correct type (`info`, `tip`, `warning`, `danger`) for the context.
106106- [ ] Tables are properly formatted with pipe characters.
107107- [ ] Code blocks use language identifiers.
@@ -110,7 +110,7 @@ When reviewing a pull request, verify the following:
110110# ## Writing Style & Readability
111111
112112- [ ] Tone is **informal, friendly, and inviting** — avoid overly formal or academic language.
113- - [ ] Title case : Use title case for section and subsection headings; articles and short prepositions stay lowercase.
113+ - [ ] Title case : Use title case for page title and section headings; articles and short prepositions stay lowercase.
114114- [ ] Language is **simple and clear** — short sentences, common words, no unexplained jargon — so non-native English speakers can easily follow.
115115- [ ] Logic is easy to follow, examples are kept simple.
116116- [ ] Claim calibration : Calibrate verbs to evidence; do not write "proves" when the evidence is "suggests".
You can’t perform that action at this time.
0 commit comments