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

write-api-docs

Add JSDoc to public exports in Remix packages using package.json exports.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps Remix package maintainers write and audit public API docs, focusing on exporting symbols with clear JSDoc comments and compliance with lint rules, so users understand the public surface.

Core Features & Use Cases

  • Document public exports by tracing package.json exports to src entry points and adding concise JSDoc on public declarations.
  • Enforce ESLint JSDoc rules and ensure reachable documentation from public entry points.
  • Use case: you publish a new public API surface; use this skill to update or tighten docs so end users can import and use it confidently.

Quick Start

Identify public exports from package.json, locate their src entry points, and add concise JSDoc to public declarations.

Frequently Asked Questions about write-api-docs

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

FAQPage Schema
How do I add JSDoc comments to public API exports in a Remix package?▼

Trace your package.json exports to locate src entry files, then add concise JSDoc to all exported functions, classes, interfaces, and type aliases to document the public API surface.

What is the best way to audit TypeScript API docs for public exports?▼

Trace package.json exports to src entry files, verify JSDoc exists on public declarations, and run ESLint checks to enforce documentation rules across the public surface.

Does this API documentation approach work with ESLint JSDoc rules?▼

Yes, it enforces ESLint JSDoc rules on public declarations. It checks exported functions, classes, interfaces, and option objects to ensure documentation is reachable from public entry points.

How do I identify which TypeScript exports need JSDoc in my package?▼

Follow package.json exports to target src entry files. Any exported functions, classes, interfaces, type aliases, or option objects found there constitute the public API surface requiring JSDoc.

When should I update JSDoc on exported functions and interfaces?▼

Update or tighten JSDoc when publishing a new public API surface, modifying exported functions or interfaces, or when ESLint checks fail on public declarations across packages.

Related Skills

Explore More Software Engineering Skills→
SocketDevSocketDev
125

auditing-api-surface

Identifies and classifies unused package exports by severity for a GitHub repo.

Official
Advanced
helderbertohelderberto
114

lint

Run tsc noEmit and eslint lint checks on TypeScript and JavaScript projects.

Community
Intermediate
lucasfdigitallucasfdigital

lint-and-validate

Lint and validate Node.js and Python code with ESLint, tsc, Ruff, and Bandit.

Community
Intermediate
chaorenex1chaorenex1
3

api-document-generator

Parse code files to generate OpenAPI 3.0.3 compliant Markdown documentation.

Community
Advanced