write-api-docs
Write or audit public API docs for Remix packages. Use when adding or tightening JSDoc on exported functions, classes, interfaces, type aliases, or option objects.
Best for Remix package maintainersWorks with GitHubLow risk
⌘source
- author
@remix-run- repo
- remix-run/remix
- language
- TypeScript
★33kstars
2.8kforks
Apr 21, 2026
✦overview.md
Key Features
- ·Documents public API exports for Remix packages
- ·Focuses on JSDoc for exported functions, classes, and types
- ·Follows package.json exports as source of truth
- ·Ensures compliance with ESLint JSDoc rules
- ·Includes type checking and linting steps
Use Cases
- →Adding JSDoc documentation to newly exported Remix package APIs
- →Auditing and improving existing API documentation for consistency
- →Ensuring public API documentation passes linting rules before release
Best for
- ✓Remix package maintainers
- ✓API documentation reviewers
Not ideal for
- !Documenting internal helper functions
- !Non-Remix projects
- !One-off documentation tasks
FAQs
name
write-api-docs
description
Write or audit public API docs for Remix packages. Use when adding or tightening JSDoc on exported functions, classes, interfaces, type aliases, or option objects.
Write API Docs
Overview
Use this skill when documenting public APIs in Remix packages.
The goal is to document the API users can actually import, not every helper in src/lib.
Work from the package exports outward, add concise JSDoc to the public declarations, and make sure the result passes the repo's ESLint JSDoc rules.
Workflow
- Identify the package's public exports.
- Find the
srcentry files that back those exports. - Trace those entry files to the declarations they re-export from
src/lib. - Add or tighten JSDoc on the public declarations only.
- Run package typecheck if appropriate and always run
pnpm run lint.
How To Identify Public API
The source of truth is the package's package.json.
- Start with
package.jsonexports. - Each public export should map to a file directly under
src/. - Those
src/*.tsentry files define the public surface by re-exporting symbols fromsrc/lib. - A declaration in
src/libis public only if it is re-exported by one of those publicsrc/*.tsentry files.
Rules:
- Do not assume everything in
src/libis public. - Do not document private helpers just because they are exported within
src/lib.
$install
1-click copynpx skills add remix-run/remix --skill write-api-docsSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
5/ 5
excellentVery clear and well structured, with almost no room for misunderstanding.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
5/ 5
very highHighly actionable with clear, concrete steps that an agent can follow directly.