Agent skill

Write API Docs

Write or audit public API docs for Remix packages. An agent skill from remix-run/remix.

MITAuto-check passedDevelopment

Install Write API Docs

skills CLI

$ npx skills add remix-run/remix --skill write-api-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-api-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/write-api-docs .claude/skills/write-api-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "write-api-docs" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-api-docs into .claude/skills/write-api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-api-docs", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/remix-run/remix/tree/main/.agents/skills/write-api-docs

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add remix-run/remix --skill write-api-docs -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-api-docs --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/write-api-docs .agents/skills/write-api-docs && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "write-api-docs" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-api-docs into .agents/skills/write-api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-api-docs", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add remix-run/remix --skill write-api-docs -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-api-docs --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/write-api-docs .cursor/skills/write-api-docs && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "write-api-docs" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-api-docs into .cursor/skills/write-api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-api-docs", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/remix-run/remix.git --path .agents/skills/write-api-docs

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add remix-run/remix --skill write-api-docs -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-api-docs --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/write-api-docs .gemini/skills/write-api-docs && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "write-api-docs" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-api-docs into .gemini/skills/write-api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-api-docs", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install remix-run/remix write-api-docs

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add remix-run/remix --skill write-api-docs -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/write-api-docs .github/skills/write-api-docs && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "write-api-docs" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-api-docs into .github/skills/write-api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-api-docs", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add remix-run/remix --skill write-api-docs -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install remix-run/remix write-api-docs --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/remix-run/remix.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/write-api-docs .opencode/skills/write-api-docs && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "write-api-docs" agent skill from https://github.com/remix-run/remix/tree/main/.agents/skills/write-api-docs into .opencode/skills/write-api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "write-api-docs", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: write-api-docs
GitHub stars: 33k
Token cost: ~1.4k tokens
SKILL.md length: 689 words
Files: 1
Skills in repo: 19
Repo updated: Oct 6, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

Write or audit public API docs for Remix packages. An agent skill from remix-run/remix.

Works in 5 steps: Identify the package's public exports. → Find the src entry files that back those… → Trace those entry files to the… → …
Tightening JSDoc on exported functions
SKILL.md covers Overview, Workflow, How To Identify Public API and What To Document, plus 3 more sections
Calls pnpm

What it does

Write API Docs is an agent skill from remix-run/remix. 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.

Its SKILL.md is about 1.4k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The repository describes itself as: The fully-stacked web framework. The licence is MIT.

When your agent uses it

Tightening JSDoc on exported functions
Tasks that involve Technical documentation

Example prompts

“/write-api-docs”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

Identify the package's public exports.
Find the src entry 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.

What it can do on your machine

Read from SKILL.md and the folder at commit 27bd7a4. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
Shell commands in SKILL.md call:
- pnpm
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md. Its commands use pnpm, which can reach the network depending on how they are called.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Write API Docs loads about 1.4k tokens when it runs. Until then it costs about 45 tokens; SKILL.md has 689 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~45
When it runs · the whole SKILL.md, loaded when a task matches: ~1.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from remix-run/remix at commit 27bd7a4, republished under its MIT licence (© remix-run). 689 words, ~1,371 tokens.

Download SKILL.mdSave it as .claude/skills/write-api-docs/SKILL.md (or your agent's skills folder).

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.

This skill owns detailed JSDoc style and lint expectations. If documenting an API reveals that the TypeScript contract itself should change, use the typescript-expert skill for the type design work.

Workflow

Identify the package's public exports.
Find the src entry 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.json exports.
Each public export should map to a file directly under src/.
Those src/*.ts entry files define the public surface by re-exporting symbols from src/lib.
A declaration in src/lib is public only if it is re-exported by one of those public src/*.ts entry files.

Rules:

Do not assume everything in src/lib is public.
Do not document private helpers just because they are exported within src/lib.
If a declaration is not reachable from a package export, it is internal unless the user explicitly asks otherwise.

What To Document

For public API, add JSDoc to:

exported functions
exported classes
exported interfaces
exported type aliases
exported public constants when they are part of the API shape

For public interfaces:

add a JSDoc block on the interface itself
add a property-level JSDoc block for every property on the interface, even when the name seems obvious

For public object-shaped type aliases:

prefer an interface when you are introducing a new public object shape
if an existing public type alias cannot reasonably become an interface, document the object shape as thoroughly as the syntax allows

For overloads:

document the public overload signatures or the exported declaration in a way that makes the callable surface clear to users

Show full SKILL.md (337 more words)Show less

JSDoc Style For This Repo

Keep comments short, factual, and user-facing.

Describe what the API does, not how the implementation works internally.
Prefer one concise summary sentence, then short @param / @returns docs as needed.
Do not put TypeScript types in JSDoc tags. ESLint forbids JSDoc type syntax here because the source of truth is the TypeScript signature.
Keep parameter names in JSDoc exactly aligned with the function signature.
Use @returns for non-void functions and include a real description.
For @param, include descriptions and do not add a hyphen before the description.
Specify @param default values in parenthesis at the end of the comment, do not use @default tags
Include an @example code block when it helps to show a use-case or pattern. Skip @example for simple getters, trivial constructors, or APIs whose usage is self-evident.
Use {@link API} to link to related Remix APIs when it adds value. Don't link every related API — use discretion to avoid noise.
Use backticks for all other unlinked code references — identifiers, HTTP methods, special values.

Good:

/**
 * Creates an {@link AuthProvider} for direct credentials-based authentication.
 *
 * @param options Parsing and verification hooks for submitted credentials.
 * @returns A provider that can be passed to `createAuthLoginRequestHandler()`.
 */
export function createCredentialsAuthProvider(...) {}

Avoid:

/**
 * @param {CredentialsAuthProviderOptions} options - options
 * @returns {CredentialsAuthProvider}
 */

ESLint Expectations

The relevant rules live in eslint.config.js.

For packages/**/*.{ts,tsx} (excluding tests), ESLint enforces JSDoc on callable declarations such as:

function declarations
function expressions
arrow functions
class declarations
public methods

Important enforced details:

jsdoc/require-param
jsdoc/require-param-name
jsdoc/require-param-description
jsdoc/require-returns
jsdoc/require-returns-description
jsdoc/no-types
jsdoc/check-param-names
jsdoc/check-types
jsdoc/check-alignment

Practical implication:

if a public function takes parameters, document all of them
if a public function returns a value, document the return value
do not use JSDoc type annotations
keep the block formatted cleanly enough to satisfy alignment checks

Review Checklist

Did you start from package.json exports instead of guessing from src/lib?
Are all documented declarations actually reachable from a public src/*.ts entry file?
Do all public functions and methods have JSDoc with @param and @returns where required?
Do public interfaces and type aliases have a concise doc block explaining what they represent?
Does every property on every public interface have its own property-level JSDoc block?
Did you avoid documenting internal helpers that are not exported publicly?
Did pnpm run lint pass?

Files

Just SKILL.md in .agents/skills/write-api-docs of remix-run/remix.

Open the folder on GitHubat commit 27bd7a4

Compare with similar skills

Write API Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Write API Docs compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Write API Docs this skillremix-run/remix	33k	—	~1.4k	Automated safety check: Pass	MIT	yesterday
Diagram Designcathrynlavery/diagram-design	44k	1 repos	~7.5k	Automated safety check: Pass	MIT	today
Simple Englishmoeru-ai/airi	50k	2 repos	~4.6k	Automated safety check: Pass	MIT	today
Get API Docs with chubandrewyng/context-hub	14k	2 repos	~775	Automated safety check: Pass	MIT	4 mo ago
Doc SyncJetBrains/ideavim	10k	2 repos	~2.6k	Automated safety check: Pass	MIT	today
Mailspring App ScreenshotsFoundry376/Mailspring	18k	—	~1.4k	Automated safety check: Pass	GPL-3.0	today

Similar skills

Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
44k GitHub starsUsed in 1 repo~7.5k tokens
DevelopmentAuto-check passed
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
50k GitHub starsUsed in 2 repos~4.6k tokens
DevelopmentAuto-check passed
Get API Docs with chub
andrewyng/context-hub
Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.
14k GitHub starsUsed in 2 repos~775 tokens
DevelopmentAuto-check passed
Doc Sync
JetBrains/ideavim
Official
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
10k GitHub starsUsed in 2 repos~2.6k tokens
DevelopmentAuto-check passed
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
18k GitHub stars~1.4k tokensUpdated today
DevelopmentAuto-check passed
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
10k GitHub stars~2.4k tokensUpdated 5 days ago
DevelopmentAuto-check: notes

Questions about Write API Docs

What does Write API Docs do?

Write or audit public API docs for Remix packages. An agent skill from remix-run/remix. Write API Docs is an agent skill from remix-run/remix. Write or audit public API docs for Remix packages.

When should I use Write API Docs?

Write API Docs fits situations like: tightening JSDoc on exported functions; tasks that involve Technical documentation.

How do I install Write API Docs in Claude Code?

Run `npx skills add remix-run/remix --skill write-api-docs -a claude-code`. Or copy the skill folder (.agents/skills/write-api-docs in remix-run/remix) into .claude/skills/write-api-docs in your project. Claude Code loads it when a task matches its description.

How do I install Write API Docs in Codex?

Run `npx skills add remix-run/remix --skill write-api-docs -a codex`. Or copy the skill folder (.agents/skills/write-api-docs in remix-run/remix) into .agents/skills/write-api-docs in your project. Codex loads it when a task matches its description.

Can I use Write API Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add remix-run/remix --skill write-api-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/write-api-docs, .gemini/skills/write-api-docs, .github/skills/write-api-docs and .opencode/skills/write-api-docs in your project.

What does Write API Docs need to run?

Going by SKILL.md and its folder, Write API Docs needs the command-line tools its instructions call (pnpm).

Does Write API Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Write API Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Write API Docs use?

Write API Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Write API Docs use?

About 1.4k tokens (SKILL.md is roughly 5.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Write API Docs?

Skills that share tags, products or a category with Write API Docs: Diagram Design (cathrynlavery/diagram-design, 44k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Write API Docs?

remix-run (a GitHub organization) maintains it in remix-run/remix, which has 33,396 GitHub stars. The repository holds 19 skills in this directory. The repository was last updated on October 6, 2026.

Source: remix-run/remix on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install Write API Docs

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Write API Docs

Overview

Workflow

How To Identify Public API

What To Document

JSDoc Style For This Repo

ESLint Expectations

Review Checklist

Files

Compare with similar skills

Similar skills

More from remix-run/remix

Related

Questions about Write API Docs