tutorial-generator

What problem does it solve?

This Skill keeps your project tutorials in sync with the codebase by automatically analyzing recent changes and updating docs/Tutorial.md. It eliminates manual, error-prone edits and ensures the team always references up-to-date guidance.

Core Features & Use Cases

• Change-analysis: Scans modified files to understand what was altered (functions, classes, configurations).
• Documentation extraction: Extracts relevant details and usage patterns to populate the Tutorial.md.
• Structured updates: Appends or updates sections like Getting Started, Recent Changes, Project Structure, Key Components, and How It Works while preserving existing content.
• Timestamp maintenance: Updates the auto-update timestamp to reflect the latest change.
• Use Case: After merging a feature branch, automatically refresh docs/TUTORIAL.md so onboarding and reviews reflect the new behavior.

Quick Start

Run the Tutorial Generator after code changes to automatically refresh docs/Tutorial.md with a full summary of what changed and how to use the new code.