docs-doc-component
CommunityStandardize Retikz component docs for faster onboarding.
Content & Communication#documentation#technical writing#examples#mdx#component APIs#docs structure#retikz
AuthorPionpill
Version1.0.0
Installs0
System Documentation
What problem does it solve?
It solves inconsistent, hard-to-scan documentation for Retikz component pages by enforcing a predictable structure and example/API conventions that help readers learn and reference components quickly.
Core Features & Use Cases
- 6-section component-page structure: Enforces the required Usage → Examples → API Reference order, with optional Composition / How it works / Related, following Retikz-specific rules.
- Copy-ready Examples organization: Guides how to group multiple demos by theme, keep Examples focused on usage, and avoid mixing in deep mechanism explanations.
- Clear boundary between Examples and How it works: Ensures deepdive content appears only where it’s truly needed (e.g., namespaces, transforms, bbox/compile behavior, edge-case conflicts).
Quick Start
Update or add a Retikz component page under apps/docs/src/contents/<module>/components/** following the docs-doc-component 6-section order and Examples/API table rules.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: docs-doc-component Download link: https://github.com/Pionpill/retikz/archive/main.zip#docs-doc-component Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.