document-recipe

Automate Styleframe recipe documentation via pattern extraction, source analysis, draft, and conformance check.

91|4|Updated Jun 20, 2025

Search Tags:#automation #documentation #writing #markdown #recipe #conformance #styleframe

Ready to run

npx skills add https://github.com/styleframe-dev/styleframe --skill document-recipe

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-recipe
Source: https://github.com/styleframe-dev/styleframe/tree/main/.claude/skills/document-recipe
Command: npx skills add https://github.com/styleframe-dev/styleframe --skill document-recipe

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Pattern-extraction driven documentation flow for Styleframe recipes; it produces final docs aligned with existing recipe docs, auto-selecting reference pages based on color patterns.

Core Features & Use Cases

4-phase documentation workflow: pattern extraction → source analysis → draft → conformance check.
Auto-selects reference pages based on color patterns (badge.md for Full, card.md for Container, spinner.md for Minimal).
Writes the final doc to apps/docs/content/docs/04.components/02.composables/<nn>.<name>.md.
Standalone-capable — runs against an existing recipe even without prior artifacts.
Absorbs the previous generic write-docs skill.

Quick Start

Invoke the document-recipe skill against a recipe to generate a publication-ready documentation page.

Frequently Asked Questions about document-recipe

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

FAQPage Schema

How do I automate recipe documentation for TypeScript source files?▼

Automating recipe documentation involves executing a four-phase process: pattern extraction, source analysis, drafting, and a conformance check. This workflow analyzes existing TypeScript sources and recipe docs to generate publication-ready markdown files.

Can I generate markdown documentation for a standalone recipe without prior artifacts?▼

Yes, you can generate markdown documentation for a standalone recipe without prior artifacts. The documentation workflow runs independently against an existing recipe, extracting patterns and analyzing sources to produce a complete, conformance-checked final document.

How does pattern extraction work when writing component composables documentation?▼

Pattern extraction for component composables documentation works by auto-selecting reference pages based on color patterns. It matches Full patterns to badge.md, Container to card.md, and Minimal to spinner.md to ensure draft alignment with existing recipe formats.

What is the best way to ensure conformance in Styleframe recipe documentation?▼

The best way to ensure conformance in Styleframe recipe documentation is through an automated four-phase workflow. The final conformance check phase validates the drafted markdown against extracted patterns and reference pages before writing the output file.

Where does the automated documentation workflow write the final markdown file?▼

The automated documentation workflow writes the final markdown file to a specific composables directory. The generated output is saved as apps/docs/content/docs/04.components/02.composables/<nn>.<name>.md within your project structure.

Does the recipe documentation process support multi-step recipe chains?▼

Yes, the recipe documentation process supports both standalone recipes and recipe chains. It executes the pattern extraction and source analysis phases across the entire chain, ensuring all linked recipes receive consistent, publication-ready documentation.