Document inline TypeScript code with concise JSDoc comments.
npx skills add https://github.com/christopher-buss/flux --skill jsdoc-christopher-buss
Please help me install this Agent Skill. Skill: jsdoc Source: https://github.com/christopher-buss/flux/tree/main/.agents/skills/jsdoc Command: npx skills add https://github.com/christopher-buss/flux --skill jsdoc-christopher-buss
This skill provides guidelines for writing minimal, high-quality JSDoc comments in TypeScript codebases to improve clarity and maintainability.
Annotate public APIs with concise, behavior-focused JSDoc using the recommended tags in the stated order.
High-intent search queries and answers about installing and using this skill.
To document TypeScript code with JSDoc, annotate public APIs, interfaces, and functions with concise comments. Apply recommended tags in a specified order to ensure consistent, behavior-focused inline documentation across the codebase.
When documenting TypeScript APIs with JSDoc, emphasize describing what the code does rather than duplicating TypeScript types. This approach provides clear patterns for properties, enums, and functions without redundant type information.
JSDoc guidelines for TypeScript apply to projects seeking consistent inline documentation for interfaces, functions, and APIs. They suit codebases documenting configuration options and APIs to assist maintainers and users of generated docs.
Downstream actions for JSDoc comments include generating external API documentation and providing inline context for maintainers. Standardized tags like @example and @deprecated structure the output for generated docs and usage guides.
vecearGenerate Markdown or HTML API documentation from TypeScript sources using JSDoc comments.
dodygGenerate DocFX metadata, OpenAPI specs, and versioned HTML documentation for .NET projects.
mwathibenReview TypeScript and JavaScript diffs against Metabase coding standards.
masrurimzGenerate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.
