write-ui-module-readme

Official

Craft concise UI module READMEs for fast adoption

Authorremix-run
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This task produces concise, agent-friendly module READMEs for UI primitives, enabling rapid adoption and correct usage without exposing implementation details.

Core Features & Use Cases

  • Generate focused, module-level READMEs for UI primitives found under packages/ui/src/lib/*.
  • Explain each exported value briefly, include a practical usage example, and capture important behavior guarantees.
  • Produce a ready-to-publish README structure suitable for documentation tooling and onboarding new contributors.

Quick Start

Provide a short canonical summary of the module exports and a minimal usage example as a ready-to-copy template.

Dependency Matrix

Required Modules

None required

Components

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: write-ui-module-readme
Download link: https://github.com/remix-run/remix/archive/main.zip#write-ui-module-readme

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.