walkthrough

Installation
SKILL.md

Codebase Walkthrough Generator

Generate interactive HTML files with clickable Mermaid diagrams that give new developers a quick mental model of how a feature or system works. The goal is fast onboarding — a rough map of concepts and connections, not a code reference. Each walkthrough should be readable in under 2 minutes.

CRITICAL: When this skill is triggered, you MUST generate a walkthrough-*.html file. Never respond with just text — always produce the interactive HTML output.

Always dark mode. Every walkthrough uses a pure black background (#000000), white text, and purple accents. Never generate light-mode walkthroughs. The <html> tag MUST include style="color-scheme: dark".

Workflow

Step 1: Understand the scope

Clarify what the user wants explained:

  • A specific feature flow (e.g., "how does canvas drawing work")
  • A data flow (e.g., "how does state flow from composable to component")
  • An architectural overview (e.g., "how are features organized")
  • A request lifecycle (e.g., "what happens when a user clicks draw")
  • A database schema (e.g., "explain the tables and relationships")
  • A data model (e.g., "how is user data structured")
Installs
359
GitHub Stars
135
First Seen
Feb 8, 2026
walkthrough — alexanderop/walkthrough