jsdocs

What problem does it solve? Public API documentation in the Effect codebase must follow a strict JSDoc structure enforced by a custom oxlint rule, and writing or fixing these comments by hand is error-prone and inconsistent. ## Core Features & Use Cases - Standardized Documentation Shape: Enforces a required template with a one-paragraph short description, ordered optional sections (When to use, Details, Gotchas), titled examples, and correctly ordered tags (@deprecated, @default, @see, @category, @since). - Module Refinement Audits: Performs dedicated @see and Gotchas audits across a module to keep cross-references semantically useful and surface real caveats. - Executable Examples: Supports import.meta.vitest runnable examples validated with pnpm doctest, plus lint validation through the custom jsdocs rule. - Use Case: When adding a new public function to an Effect module, use this Skill to generate compliant JSDoc with a deterministic example, correct @category and @since tags, and then validate it with pnpm lint. ## Quick Start Write compliant JSDoc for the new public API I just added to this Effect module and validate it with the jsdocs lint rule.