JSDoc Skill

This skill provides focused guidelines for writing JSDoc comments consistently across the codebase.

When to Use

• Documenting exported type properties and configuration options
• Adding context that TypeScript types don't convey on their own
• Providing usage examples for non-obvious or multi-variant APIs
• Writing inline documentation for generated docs

What It Does

• Defines @example format conventions (label + inline backtick or fenced block)
• Ensures every exported type and property has meaningful documentation
• Avoids redundant tags that duplicate TypeScript type information
• Ensures consistent documentation style across all packages