rules-docs

What problem does it solve?

This Skill ensures that documentation within the docs/ directory remains accurate, up-to-date, and consistent with the project's codebase and architectural standards.

Core Features & Use Cases

• Link Validation: Verifies that all internal links and file references within documentation are valid and point to existing resources.
• Content Alignment: Ensures architectural claims and descriptions in docs match the actual code implementation.
• Placeholder Removal: Detects and flags common placeholders like TODO, FIXME, and TBD, prompting their resolution.
• Path Consistency: Enforces the use of repository-relative paths to maintain link integrity across different environments.
• Use Case: When updating a feature in flext-core, this Skill helps ensure that the corresponding architectural diagrams and usage guides in docs/architecture/ are updated accordingly and that all links remain functional.

Quick Start

Use the rules-docs skill to validate all markdown files in the docs directory.