Skip to content

Commit dea7702

Browse files
committed
chore: add cursor rules
1 parent 987e7eb commit dea7702

File tree

2 files changed

+653
-0
lines changed

2 files changed

+653
-0
lines changed

.cursor/rules/docs-formatting.mdc

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
globs: docs/**/*.md
3+
alwaysApply: false
4+
description: Documentation formatting guidelines for files in the docs directory
5+
---
6+
7+
# Documentation Formatting Guidelines
8+
9+
When writing documentation files in the docs directory:
10+
11+
## Header Structure
12+
13+
- Use minimal header nesting - prefer level 1 (`#`) and level 2 (`##`) headers
14+
- Level 3 headers (`###`) are allowed when they significantly improve readability and document structure
15+
- **Method names, function signatures, and similar structured content** should use level 3 headers (`###`) for better navigation and clarity
16+
- For other sub-sections that would normally be level 3 or deeper, consider using **bold text** or other formatting instead
17+
- Preserve logical hierarchy and importance in your header structure
18+
19+
## Spacing Requirements
20+
21+
- Always leave a blank line after any title/header
22+
- Always leave a blank line before any list (bulleted or numbered)
23+
- This ensures proper visual separation and readability
24+
25+
## Examples
26+
27+
Good formatting:
28+
```markdown
29+
# Main Title
30+
31+
Content here...
32+
33+
## Section Title
34+
35+
More content...
36+
37+
### Method Name or Structured Content
38+
39+
Detailed information...
40+
41+
- List item 1
42+
- List item 2
43+
```
44+
45+
Avoid:
46+
```markdown
47+
# Main Title
48+
Content immediately after title...
49+
#### Excessive nesting
50+
- List without spacing above
51+
```

0 commit comments

Comments
 (0)