documentation-update

What problem does it solve?

Outdated or inconsistent documentation leads to confusion, miscommunication, and developers using deprecated patterns, hindering adoption and efficiency. This Skill automates the process of keeping design system documentation synchronized with the codebase, ensuring accuracy and reliability.

Core Features & Use Cases

• Content Synchronization: Updates key documentation files (e.g., accessibility-guide.md, theme-mapping.md) with the latest token definitions, component patterns, and workflows.
• Code Example Verification: Ensures all code examples in the documentation accurately reflect the current component implementations and syntax.
• Workflow & Validation Updates: Documents new validation methods, changes to build pipeline procedures, and deprecates outdated commands.
• Cross-Reference Maintenance: Manages internal links and references to source files, preventing broken links and improving navigability.
• Use Case: After a major refactoring of your button components, use this skill to automatically update all relevant documentation sections, including code examples for new props and accessibility guidelines.

Quick Start

Use the documentation-update skill to synchronize all code examples in the documentation with the current component implementations.