walkthrough

Generate and validate Forge .walkthrough.json review artifacts from repository changes.

1|Updated Sep 3, 2017
One-click install
npx skills add https://github.com/mmgeorge/config --skill walkthrough-mmgeorge
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: walkthrough
Source: https://github.com/mmgeorge/config/tree/main/rulesync-global/.rulesync/skills/walkthrough
Command: npx skills add https://github.com/mmgeorge/config --skill walkthrough-mmgeorge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Creating guided code review walkthroughs by hand is slow and error-prone, especially when the output must conform to a strict JSON schema consumed by the Forge Neovim plugin. This Skill automates the generation, regeneration, validation, and repair of .walkthrough.json artifacts directly from repository changes. ## Core Features & Use Cases - Subagent-Based Generation: Dispatches the full walkthrough workflow to a walkthrough-writer subagent, keeping semantic discovery, patch extraction, and schema validation out of the parent context. - Schema Validation & Repair: Validates artifacts against walkthrough.schema.json and routes repairable errors back to the same subagent to preserve cached repository context. - Use Case: After making local modifications to a repository, ask for a review walkthrough and receive a schema-valid .walkthrough.json at the repository root, ready for the Forge Neovim plugin's guided review navigation. ## Quick Start Generate a Forge walkthrough artifact for the current repository changes and validate it against the walkthrough schema.

Frequently Asked Questions about walkthrough

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a .walkthrough.json file for code review?▼

Invoke the walkthrough skill with your target repository path and review request. It dispatches a walkthrough-writer subagent that analyzes repository changes, builds the artifact, and validates it against walkthrough.schema.json before writing it to the repository root.

What is a Forge walkthrough artifact used for?▼

A Forge walkthrough artifact is a guided review document consumed by the Forge Neovim plugin. It contains a data-flow graph, an overview, and numbered review tasks with annotated code changes tied to specific files and lines.

Does the walkthrough skill validate the generated JSON?▼

Yes, the subagent validates the artifact against walkthrough.schema.json, which enforces required fields like version, flow, overview, root, commit, and tasks. Repairable schema errors are routed back to the same subagent instance for correction.

Why does walkthrough generation use a subagent instead of running directly?▼

The subagent isolates semantic discovery, raw patch extraction, and schema validation from the parent conversation context. This keeps the parent context clean and preserves cached repository context when validation errors need repair.

What happens if walkthrough schema validation fails?▼

If validation reports repairable schema errors, the repair request is routed back to the existing walkthrough-writer subagent instance, which retains cached repository context. If subagent invocation itself fails, the blocking failure is reported explicitly.