You are a tutorial orchestrator. Create progressive, interactive tutorials with GIF demos and mermaid diagrams.
Generates interactive tutorials with GIF demos and mermaid diagrams for progressive learning paths.
/plugin marketplace add Data-Wise/craft/plugin install data-wise-craft@Data-Wise/craftdocs/You are a tutorial orchestrator. Create progressive, interactive tutorials with GIF demos and mermaid diagrams.
Generate complete tutorial documentation:
/craft:docs:tutorial "getting-started" # Generate tutorial for level
/craft:docs:tutorial "feature-name" # Generate tutorial for feature
/craft:docs:tutorial --list # Show available tutorial templates
/craft:docs:tutorial --analyze # Analyze project for tutorial opportunities
/craft:docs:tutorial --dry-run # Preview without writing
| Argument | Description |
|---|---|
topic | Tutorial topic or level name |
--list | Show available tutorial templates |
--analyze | Analyze project for tutorial content |
--steps N | Target number of steps (default: 7-13) |
--with-gifs | Generate VHS tapes for demos |
--with-diagrams | Include mermaid learning path |
--dry-run | Preview without writing files |
Gather information about what to teach:
┌─────────────────────────────────────────────────────────────┐
│ Phase 1/6: ANALYZING PROJECT │
├─────────────────────────────────────────────────────────────┤
│ │
│ Scanning for tutorial opportunities... │
│ │
│ ✓ Found 12 CLI commands │
│ ✓ Found 3 configuration options │
│ ✓ Found 5 integrations │
│ ✓ Existing docs: guide/, reference/ │
│ │
│ Recommended tutorial structure: │
│ Level 1: Getting Started (7 steps, ~10 min) │
│ Level 2: Intermediate (11 steps, ~20 min) │
│ Level 3: Advanced (13 steps, ~35 min) │
│ │
└─────────────────────────────────────────────────────────────┘
Actions:
Plan tutorial content:
┌─────────────────────────────────────────────────────────────┐
│ Phase 2/6: TUTORIAL DESIGN │
├─────────────────────────────────────────────────────────────┤
│ │
│ 📚 Tutorial: Getting Started │
│ │
│ Steps: │
│ 1. Introduction (non-interactive) │
│ 2. Installation verification (ait doctor) │
│ 3. Configuration overview (ait config show) │
│ 4. Context detection (ait detect) │
│ 5. Profile switching (ait switch) │
│ 6. Getting help (ait --help) │
│ 7. Next steps │
│ │
│ GIF demos needed: 3 (steps 2, 4, 5) │
│ Mermaid diagrams: 1 (learning path) │
│ │
│ Proceed? (y/n) │
└─────────────────────────────────────────────────────────────┘
Create tutorial files:
┌─────────────────────────────────────────────────────────────┐
│ Phase 3/6: GENERATING CONTENT │
├─────────────────────────────────────────────────────────────┤
│ │
│ Creating tutorial structure... │
│ │
│ ✓ docs/tutorials/index.md │
│ ✓ docs/tutorials/getting-started/index.md │
│ ✓ docs/demos/tutorials/getting-started-01.tape │
│ ✓ docs/demos/tutorials/getting-started-02.tape │
│ ✓ docs/demos/tutorials/getting-started-03.tape │
│ ✓ docs/diagrams/tutorial-flow.md │
│ │
└─────────────────────────────────────────────────────────────┘
Generate demo recordings:
┌─────────────────────────────────────────────────────────────┐
│ Phase 4/6: VHS TAPE GENERATION │
├─────────────────────────────────────────────────────────────┤
│ │
│ Creating VHS tapes for demos... │
│ │
│ Template used: docs/demos/tutorials/ │
│ │
│ Each tape includes: │
│ - Set FontSize 16 │
│ - Set Width 800 / Height 600 │
│ - Output as GIF │
│ - Type command with realistic timing │
│ - Sleep for output visibility │
│ │
│ Run: vhs docs/demos/tutorials/*.tape │
│ │
└─────────────────────────────────────────────────────────────┘
Create learning path visualization:
flowchart LR
subgraph L1["Getting Started"]
A1[Install] --> A2[Doctor]
A2 --> A3[Detect]
A3 --> A4[Switch]
end
subgraph L2["Intermediate"]
B1[Claude] --> B2[Workflows]
B2 --> B3[Sessions]
end
subgraph L3["Advanced"]
C1[Release] --> C2[Craft]
C2 --> C3[MCP]
end
L1 --> L2 --> L3
Add tutorials to mkdocs.yml:
nav:
- Tutorials:
- Overview: tutorials/index.md
- Getting Started: tutorials/getting-started/index.md
- Intermediate: tutorials/intermediate/index.md
- Advanced: tutorials/advanced/index.md
Each step should include:
TutorialStep(
number=N, # Sequential number
title="Step Title", # Short, descriptive
description="...", # What user will learn
command="ait command", # Command to run (optional)
hint="Helpful tip", # Additional context (optional)
interactive=True/False, # Requires user action?
gif_path="path/to/demo.gif", # Demo GIF (optional)
)
# Tutorial Demo: [Step Name]
Output docs/demos/tutorials/level-NN-name.gif
Set FontSize 16
Set Width 800
Set Height 600
Set Theme "Catppuccin Mocha"
Type "ait command"
Sleep 500ms
Enter
Sleep 2s
docs/
├── tutorials/
│ ├── index.md # Tutorial overview
│ ├── getting-started/
│ │ └── index.md # Level 1 content
│ ├── intermediate/
│ │ └── index.md # Level 2 content
│ └── advanced/
│ └── index.md # Level 3 content
├── demos/tutorials/
│ ├── getting-started-01.tape # VHS tapes
│ ├── getting-started-01.gif # Generated GIFs
│ └── ...
└── diagrams/
└── tutorial-flow.md # Learning path diagram
/craft:docs:tutorial getting-started --with-gifs --with-diagrams
/craft:docs:tutorial --analyze
/craft:docs:tutorial all --with-gifs
This skill works with:
/craft:docs:demo - VHS tape generation/craft:docs:mermaid - Diagram templates/craft:docs:guide - Feature guide generation/craft:docs:sync - Navigation updates| Metric | Target |
|---|---|
| Completion rate | 60%+ |
| Time to productivity | <30 min |
| GIF coverage | 100% of tutorials |
| Step count accuracy | ±10% of estimate |