Skip to content

Commit 13ec4eb

Browse files
committed
docs(documentation): switch heading style guidance to title case
- 810-documentation.mdc: in the Structure section, add a bullet that headings should use title case while preserving established acronyms and product names - skills/documentation-standards/SKILL.md: replace the "Use sentence case" guidance under Headers with the same title-case + acronym/ product-name rule, keeping the two surfaces in sync Title case reads better in tables of contents, navigation rails, and shared chats / emails where headings are excerpted; preserving acronyms (API, JWT, OIDC) and product names (PostgreSQL, Kafka, Cloudflare) avoids the visual noise of forcing them to title case. The 810 rule and the documentation-standards skill are the two canonical sources for documentation style; this aligns both.
1 parent 331baac commit 13ec4eb

2 files changed

Lines changed: 2 additions & 1 deletion

File tree

rules/810-documentation.mdc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,7 @@ Prefer **neutral** or **imperative** phrasing over second-person voice.
304304
- Start with overview/context
305305
- Progress from simple to complex
306306
- Use headings to organize
307+
- Use title case for headings, preserving established acronyms and product names
307308
- Include table of contents for long docs
308309

309310
### Examples

skills/documentation-standards/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ MIT - See LICENSE.
8383
### Headers
8484
- Use `#` hierarchy (don't skip levels)
8585
- Keep headers concise
86-
- Use sentence case
86+
- Use title case for headings, preserving established acronyms and product names
8787

8888
### Code Blocks
8989
````markdown

0 commit comments

Comments
 (0)