sc-readme

What problem does it solve?

This Skill automates the process of updating project documentation to accurately reflect changes made in the codebase, preventing documentation staleness and ensuring consistency.

Core Features & Use Cases

• Automated Documentation Updates: Analyzes git changes to identify affected documentation sections and updates them automatically.
• Cross-Reference Validation: Ensures consistency between code, documentation, and configuration files.
• Staleness Reporting: Identifies documentation that is out-of-date and requires attention.
• Use Case: After adding a new API endpoint, this Skill can automatically update the README.md and API documentation to include the new endpoint details, ensuring users always have accurate information.

Quick Start

Use the sc-readme skill to update the project documentation based on the latest git changes.