docs-doc-example

Standardize retikz example documentation with six-section pages and step demos.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It standardizes how retikz “examples” pages are written so readers can follow a clear, reproducible learning path rather than getting lost in inconsistent structure.

Core Features & Use Cases

  • Fixed 6-section page structure (intro with hero, Prompt, process steps, capabilities, limitations, related) to improve discoverability and consistency.
  • Teaching-first process steps with a strict 4-line Step format and TOC-ready H3 step headings that readers can jump to.
  • Prompt and demo conventions for reproducible guidance, including the ExamplePrompt layout and cumulative demo file naming rules for step-by-step learning.

Quick Start

Ask an AI to draft a new retikz example page that follows the docs-doc-example 6-section skeleton and generates cumulative step demos named <id>-NN-<theme>.demo.tsx.

Frequently Asked Questions about docs-doc-example

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

FAQPage Schema
How do I write reproducible step-by-step example documentation for MDX?

To write reproducible step-by-step example documentation, use a fixed 6-section structure with an intro, prompt, process steps, capabilities, limitations, and related sections. This enforces strict formatting and consistent YAML frontmatter for content discovery.

What is the standard format for a retikz example page?

A standard retikz example page features a fixed 6-section layout with a hero intro, an ExamplePrompt pattern, and teaching-first process steps. It uses TOC-ready H3 step headings and cumulative demo file naming rules for clear step-by-step learning.

How do I name demo files for step-by-step learning guides?

Name demo files for step-by-step learning guides using the cumulative naming convention <id>-NN-<theme>.demo.tsx. This strict demo naming rule ensures readers can easily follow and reproduce each instructional diagram construction step.

Can I include TikZ comparisons directly inside retikz process steps?

No, you should keep TikZ comparisons isolated to dedicated mechanisms within the documentation. The standardized process steps enforce a strict 4-line Step format focused on instructional flow, preventing mixed content from disrupting the learning path.

Do I need YAML frontmatter for MDX example documentation?

Yes, YAML frontmatter is a required element for MDX example documentation. Enforcing this frontmatter ensures proper page discovery and allows the standardized 6-section instructional content to be consistently indexed and accessed.