-
Notifications
You must be signed in to change notification settings - Fork 51
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
The README.md currently uses inconsistent terminology, sometimes referring to "rules" and sometimes to "skills and rules". Since Project CodeGuard provides both skills (agent-specific capabilities) and rules (security guidelines), the documentation should consistently reflect this dual nature.
Proposed Solution
Update all references throughout README.md to use "skills and rules" terminology consistently, ensuring users understand that Project CodeGuard offers both types of resources.
Specific Changes Needed
- Update main title from "Security Rules" to "Security Skills and Rules"
- Replace standalone references to "rules" with "skills and rules" throughout:
- "Before code generation" section
- "During code generation" section
- "Security Coverage" section
- "Quick Start" section
- "How It Works" section
- Update copyright year from 2025 to 2026
- Remove emoji from "Licensing" section header for consistency
- Fix typo: "skills andrules" → "skills and rules"
Benefits
- Clarity: Users will better understand that Project CodeGuard provides both skills and rules
- Consistency: Documentation will use consistent terminology throughout
- Accuracy: Reflects the actual structure and offerings of the project
Related
This is a documentation improvement that aligns with the project's dual offering of skills and rules.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation