Adds TypeDoc comments to TypeScript source files across the Medusa codebase.
npx skills add https://github.com/medusajs/medusa --skill writing-tsdocs
Please help me install this Agent Skill. Skill: writing-tsdocs Source: https://github.com/medusajs/medusa/tree/main/.claude/skills/writing-tsdocs Command: npx skills add https://github.com/medusajs/medusa --skill writing-tsdocs
Writing consistent, convention-compliant TSDoc comments across a large TypeScript monorepo is tedious and error-prone. This Skill applies Medusa's documentation standards to HTTP types, API routes, UI components, data models, service interfaces, JS SDK methods, providers, workflows, steps, and events without altering any code logic.
@featureFlag, @expandable, @since, @eventPayload, and @customNamespace defined in the project's tsdoc.json.packages/core/core-flows/src, ask the assistant to document it, and it will load the workflows-steps reference and produce a compliant TSDoc block with @summary, hooks, and @example.Add TSDoc comments to the exported workflow in packages/core/core-flows/src/cart/workflows/add-to-cart.ts following the Medusa documentation conventions.
High-intent search queries and answers about installing and using this skill.
Identify the file's path pattern, load the matching reference guide, then add TSDoc blocks only to exported items. Each file type has its own depth rules, from minimal tags on API routes to full @param, @returns, and @example blocks on service methods.
Medusa defines custom tags in its tsdoc.json including @featureFlag, @expandable, @since, @apiIgnore, @schema, @tags, @version, @keep, @customNamespace, and @namespaceMember. Standard TypeDoc tags like @param, @returns, and @example are always allowed.
No. API route handlers in packages/medusa/src/api receive only minimal documentation: @featureFlag when the handler checks a feature flag, and @since when the route is new. Handlers with neither condition get no TSDoc at all.
Use @since only when a version number is explicitly provided in the prompt and the export is new in the current commit diff. Never fabricate version numbers, and never add @since to pre-existing exports.
No. The conventions explicitly prohibit documenting test files such as *.spec.ts and __tests__ directories, as well as unexported or private items. Only exported interfaces, types, functions, and classes receive documentation.
kslhunterAutomates README updates for packages in the `packages/` directory based on git commit history and diffs.
JongsixGenerate technical documentation from source code and API definitions.
pckienuitRun linting and static validation across Node.js, TypeScript, and Python projects.
LounisBouStandardize TypeScript API documentation with TSDoc conventions for functions, classes, interfaces, and types.