scaffold

Generate architecture diagrams, doc stubs, and a module registry from Markdown plans.

8|1|Updated Apr 8, 2026
One-click install
npx skills add https://github.com/yulonghe97/ystack --skill scaffold-yulonghe97
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scaffold
Source: https://github.com/yulonghe97/ystack/tree/main/skills/scaffold
Command: npx skills add https://github.com/yulonghe97/ystack --skill scaffold-yulonghe97

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Bridging the gap between informal project plans and polished documentation by generating a complete doc scaffold from a plan.

Core Features & Use Cases

  • Generate architecture diagrams, module stubs, and a module registry from a user-provided plan.
  • Create progress files and a docs structure that can be filled in later as features are implemented.
  • Support both full-project scaffolding and single-module additions, accommodating updates to existing docs sites.

Quick Start

Execute a plan-to-doc scaffold to bootstrap the documentation structure for your project.

Frequently Asked Questions about scaffold

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

FAQPage Schema
How do I generate documentation structure from a markdown plan?

To generate documentation structure from a markdown plan, the scaffold skill reads your Markdown files to detect modules and features, automatically producing ready-to-edit doc stubs and a complete docs skeleton.

Can I generate architecture diagrams and a module registry automatically?

Yes, you can generate architecture diagrams and a module registry automatically. The process reads your project plan to detect modules and writes a .ystack/config.json registry alongside the visual architecture diagrams.

What is the best way to create doc stubs for incremental development?

The best way to create doc stubs for incremental development is to execute a plan-to-doc scaffold, which generates progress files and a structured docs layout that you can fill in as features are implemented.

Does doc scaffolding support adding a single module to an existing docs site?

Yes, doc scaffolding supports single-module additions. It accommodates updates to existing documentation sites by generating specific module stubs and updating the module registry without overwriting the full project structure.

What format does the module registry use when scaffolding docs from a plan?

When scaffolding docs from a plan, the module registry uses the .ystack/config.json format. This configuration file is automatically written to map out the detected modules and features from your input Markdown plan.

Why use a plan-to-doc scaffold instead of manually writing documentation structure?

Using a plan-to-doc scaffold bridges the gap between informal project plans and polished documentation by automating the creation of architecture diagrams, module stubs, and progress files, saving manual setup time.