forked from trent_larson/crowd-funder-for-time-pwa
feat: enhance markdown rules for AI generation compliance
- Add AI Generation Guidelines with alwaysApply: true - Extend globs to include .mdc files - Ensure AI agents follow rules during content creation - Improve markdown automation system integration
This commit is contained in:
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
globs: *.md
|
globs: ["*.md", "*.mdc"]
|
||||||
alwaysApply: false
|
alwaysApply: false
|
||||||
---
|
---
|
||||||
# Cursor Markdown Ruleset for TimeSafari Documentation
|
# Cursor Markdown Ruleset for TimeSafari Documentation
|
||||||
@@ -10,6 +10,36 @@ This ruleset enforces consistent markdown formatting standards across all projec
|
|||||||
documentation, ensuring readability, maintainability, and compliance with
|
documentation, ensuring readability, maintainability, and compliance with
|
||||||
markdownlint best practices.
|
markdownlint best practices.
|
||||||
|
|
||||||
|
**⚠️ CRITICAL FOR AI AGENTS**: These rules must be followed DURING content
|
||||||
|
generation, not applied after the fact. Always generate markdown that complies
|
||||||
|
with these standards from the start.
|
||||||
|
|
||||||
|
## AI Generation Guidelines
|
||||||
|
|
||||||
|
### **MANDATORY**: Follow These Rules While Writing
|
||||||
|
|
||||||
|
When generating markdown content, you MUST:
|
||||||
|
|
||||||
|
1. **Line Length**: Never exceed 80 characters per line
|
||||||
|
2. **Blank Lines**: Always add blank lines around headings, lists, and code
|
||||||
|
blocks
|
||||||
|
3. **Structure**: Use proper heading hierarchy and document templates
|
||||||
|
4. **Formatting**: Apply consistent formatting patterns immediately
|
||||||
|
|
||||||
|
### **DO NOT**: Generate content that violates these rules
|
||||||
|
|
||||||
|
- ❌ Generate long lines that need breaking
|
||||||
|
- ❌ Create content without proper blank line spacing
|
||||||
|
- ❌ Use inconsistent formatting patterns
|
||||||
|
- ❌ Assume post-processing will fix violations
|
||||||
|
|
||||||
|
### **DO**: Generate compliant content from the start
|
||||||
|
|
||||||
|
- ✅ Write within 80-character limits
|
||||||
|
- ✅ Add blank lines around all structural elements
|
||||||
|
- ✅ Use established templates and patterns
|
||||||
|
- ✅ Apply formatting standards immediately
|
||||||
|
|
||||||
## General Formatting Standards
|
## General Formatting Standards
|
||||||
|
|
||||||
### Line Length
|
### Line Length
|
||||||
@@ -326,6 +356,10 @@ Description of current situation or problem.
|
|||||||
### Authentication
|
### Authentication
|
||||||
### Authorization
|
### Authorization
|
||||||
|
|
||||||
|
## Features ❌ (Duplicate heading)
|
||||||
|
### Security
|
||||||
|
### Performance
|
||||||
|
```
|
||||||
## Features ❌ (Duplicate heading)
|
## Features ❌ (Duplicate heading)
|
||||||
### Security
|
### Security
|
||||||
### Performance
|
### Performance
|
||||||
|
|||||||
Reference in New Issue
Block a user