skills.rest
remix-run
remix-runOFFICIAL
Explore all skills by this author →
Website𝕏@remix_runGitHub

write-readme

Draft Remix-style package READMEs from API surfaces and usage patterns.

33.3k|2.8k|Updated Oct 26, 2020
Search Tags:#template#documentation#markdown#readme#package#remix
One-click install
npx skills add https://github.com/remix-run/remix --skill write-readme-remix-run
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-readme
Source: https://github.com/remix-run/remix/tree/main/.agents/skills/write-readme
Command: npx skills add https://github.com/remix-run/remix --skill write-readme-remix-run

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Drafting or rewriting package READMEs to match Remix repo conventions, ensuring clarity and consistent structure.

Core Features & Use Cases

  • Produce production-oriented READMEs that mirror the Remix structure (intro, installation, usage, features, related packages, license).
  • Use existing sibling READMEs and the package API surface as references to create accurate, runnable examples.
  • Facilitate quick-start guidance so new packages can be documented rapidly.

Quick Start

Draft a Remix-style README for a given package using its API surface and existing READMEs as references.

Frequently Asked Questions about write-readme

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

FAQPage Schema
How do I write a production-ready README for a Remix package?▼

Drafting a Remix-style package README involves translating the API surface and usage patterns into concise documentation. Structure the file with intro, installation, usage, features, related packages, and license sections using existing sibling READMEs as references.

What sections should a Remix monorepo package README include?▼

A Remix monorepo package README should include an intro, installation, usage, features, related packages, and license sections. This structure mirrors the repository's conventions and ensures production-oriented clarity for new packages.

How do I generate markdown documentation from an API surface?▼

Generating markdown documentation from an API surface involves translating functions and usage patterns into realistic, runnable examples. The process targets packages within the Remix monorepo and enforces frontmatter extraction for discovery.

Can I use existing sibling READMEs as references for new package documentation?▼

Yes, you can use existing sibling READMEs as references for new package documentation. Analyzing sibling files and the package API surface helps create accurate, production-oriented READMEs that maintain consistent structure across the monorepo.

Does the README generator enforce frontmatter extraction for package discovery?▼

Yes, the README generator enforces frontmatter extraction for package discovery. It automatically handles frontmatter and links to related packages to ensure the drafted documentation follows Remix repository conventions.

What is the best way to document a new package in a Remix monorepo?▼

The best way to document a new package in a Remix monorepo is to mirror the existing README structure. Draft production-oriented documentation by translating the API surface into concise, runnable examples and linking related packages.

Related Skills

Explore More Content & Communication Skills→
jimwellerjimweller

readme

Generate markdown documentation from conversation history and directory contents.

Community
Intermediate
youdotcom-ossyoudotcom-oss
25

documentation

Enforce consistent README and AGENTS.md documentation standards across dx-toolkit packages.

Official
Basic
ianyimiianyimi
1

Global Tech Stack

Enforce coding standards for the global tech stack in Claude Code.

Community
Basic
rethinkhealthrethinkhealth
6

glion-readme

Generate and audit Diataxis-compliant READMEs for glion packages.

Official
Advanced