Cursor rule

1---
2description: Standards for maintaining README.md documentation
3globs: README.md, *.md
4alwaysApply: false
5---
6# Enhanced README Maintenance Standards
7 
8Ensures that README files are consistently maintained, up-to-date, and informative.
9 
10<rule>
11name: enhanced_readme_maintenance_standards
12description: Enforce standards for maintaining README documentation
13filters:
14  - type: file_extension
15    pattern: "\\.md$"
16  - type: file_name
17    pattern: "^README\\.md$"
18 
19actions:
20  - type: enforce
21    conditions:
22      - pattern: "## (Available Rules|Features|Components)"
23        message: "Update the 'Available Rules/Features/Components' section whenever new elements are added."
24 
25      - pattern: "\\[`[^`]+`\\]\\([^)]+\\)"
26        message: "Ensure all file references in the README are properly linked and point to existing files."
27 
28      - pattern: "## (Installation|Usage|Configuration)"
29        message: "Keep setup, usage, and configuration sections current with the latest project changes."
30 
31      - pattern: "## (Contributing|License)"
32        message: "Ensure contributing guidelines and license information are accurate and up-to-date."
33 
34      - pattern: "\\[Version\\s*(\\d+\\.)?(\\d+\\.)?\\d+\\]"
35        message: "Update version information to reflect the current state of the project."
36 
37      - pattern: "## (Changelog|Changes|Updates)"
38        message: "Maintain a changelog for significant updates, fixes, and features."
39 
40  - type: suggest
41    message: |
42      **README Maintenance Best Practices:**
43      - **Rule Listings:** Automatically update or manually check if new rules or features are reflected in the README.
44      - **Installation & Configuration:** Regularly review and update installation and configuration instructions to match the latest project state.
45      - **Documentation of Changes:** Document new features, bug fixes, and changes in a changelog or dedicated section.
46      - **Section Hierarchy:** Maintain a logical structure with clear headings for easy navigation.
47      - **Examples:** Include or update examples for new or changed functionalities.
48      - **Version Information:** Keep version numbers and release notes current, linking to the changelog if applicable.
49      - **Table of Contents:** Ensure the table of contents reflects the current document structure, using auto-generated if possible.
50      - **Badges:** Update badges for CI/CD status, test coverage, or dependencies to reflect current project health.
51      - **Accessibility:** Write with accessibility in mind, using alt text for images and semantic markdown.
52 
53  - type: validate
54    conditions:
55      - pattern: "^# [^\\n]+\\n\\n## "
56        message: "Ensure proper markdown heading hierarchy for readability."
57 
58      - pattern: "\\|[^|]+\\|[^|]+\\|\\n\\|\\s*-+\\s*\\|"
59        message: "Use consistent table formatting throughout the document."
60 
61      - pattern: "\\[(.*?)\\]\\((?!http|\\/)[^\\)]+\\)"
62        message: "All local links should point to existing files or sections within the project."
63 
64      - pattern: "\\[Version\\s*(\\d+\\.)?(\\d+\\.)?\\*\\d+\\]"
65        message: "Check that version placeholders are updated to actual numbers before release."
66 
67metadata:
68  priority: high
69  version: 1.1
70</rule>