tutorial-generator

Tutorial Generator

This skill converts an existing integration test or a set of user-provided files into a polished, step-by-step markdown tutorial. The process is collaborative and interactive — you and the LLM work together to draft and refine each section.

---

When to use this skill

• After creating an integration test, when you want to document the workflow it demonstrates as a user-facing tutorial.
• When you have example files, screenshots, or code samples that illustrate a framework feature and want to organize them into a structured tutorial.
• When you want to create educational content that walks users through a specific task or workflow.
• Whenever you run /hyper-tutorial-generator.

---

How to use it

Step 0 — Choose Your Source (HITL Gate #1)

Use AskUserQuestion to ask the user which source to use:

Option A: Existing Integration Test

• Tutorial will be based on a test file from tests/integration/
• You'll select which test and describe what aspects to focus on

Option B: User-Provided Files

• Tutorial will be built from files you provide (code, examples, docs, etc.)
• You'll describe the topic and list any supporting files

Wait for the user's selection before proceeding.

---

Step 1 — Gather Source Material

If Integration Test Mode:

1. List all files in tests/integration/ (numbered).
2. Use AskUserQuestion to let the user select which test file to use.
3. Read the selected test file in full.
4. Then ask via AskUserQuestion: "What aspects of this test should the tutorial focus on? (e.g., the core workflow, specific edge cases, debugging tips)"
5. Wait for the response.

If User Files Mode:

1. Use AskUserQuestion (two parts):
   • "What is this tutorial about? (1-2 sentences)"
   • "Do you have any input files, code samples, examples, or screenshots to include? If yes, list their file paths or paste their content directly."
2. For any listed files, read them in full (or accept pasted content).
3. Store all provided content in memory for use in later steps.