docs-figure-draw

Replace documentation illustrations with retikz-generated narrative diagrams.

12|2|Updated Nov 27, 2024
One-click install
npx skills add https://github.com/Pionpill/retikz --skill docs-figure-draw
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-figure-draw
Source: https://github.com/Pionpill/retikz/tree/main/.agents/skills/docs-figure-draw
Command: npx skills add https://github.com/Pionpill/retikz --skill docs-figure-draw

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Eliminates inconsistent and low-signal documentation illustrations by replacing ASCII, Mermaid, screenshots, or external drawings with retikz-generated, text-centric figure diagrams.

Core Features & Use Cases

  • Docs dogfooding: Produces narrative, explanatory illustrations that match retikz documentation style rather than generic diagramming.
  • Consistent figure conventions: Enforces defaults like Node stroke="none", y-axis downward, responsive width, and clear arrow semantics for data vs tool/call relationships.
  • Authoring workflow guidance: Standardizes how to structure demo files and MDX pages for single-language or (when needed) bilingual labeling.

Quick Start

Update the target documentation page by adding a retikz figure with its corresponding .demo.tsx and render it with the ComponentPreview set to hideCode.

Frequently Asked Questions about docs-figure-draw

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

FAQPage Schema
How do I generate consistent documentation diagrams for architecture and flow visualization?

Documentation diagrams are generated using retikz to replace ASCII or screenshots with narrative, text-centric figures. This enforces consistent conventions like stroke="none" default nodes and responsive width for architecture and flow visualization.

What is the best way to structure MDX pages when adding diagram generation?

To structure MDX pages for diagram generation, add a retikz figure alongside its corresponding .demo.tsx file and render it via ComponentPreview set to hideCode. This workflow standardizes demo files and MDX page layouts.

Does this approach support replacing Mermaid diagrams in React component documentation?

Yes, it replaces Mermaid diagrams and screenshots with retikz narrative diagrams in React component documentation. It targets scenarios where clarity and consistency matter more than showing source code.

How do I configure arrow semantics and coordinate systems for flowchart generation?

Configure flowchart generation by using ID-based Draw connections with correct arrow semantics for data vs tool/call relationships and y-axis-down coordinates. This enforces proper directional logic and responsive layout sizing.

When should I avoid using text-centric diagrams for concept illustration?

Avoid text-centric diagrams for concept illustration when your documentation requires showing exact source code rather than narrative explanations. This method prioritizes visual clarity and consistent conventions over code representation.