jsdocs

What problem does it solve?

Writing JSDoc for Effect public APIs that complies with the jsdocs oxlint rule is time-consuming and error-prone due to strict structural, prose, and tag requirements. This Skill eliminates the guesswork by providing clear, actionable guidance to produce consistent, lint-passing API documentation.

Core Features & Use Cases

• Standardized JSDoc Structure: Enforces the required layout including a mandatory short description, optional When to use, Details, and Gotchas sections, plus properly formatted examples.
• Prose and Tag Rules: Provides explicit guidelines for tone, section ordering, tag usage, and link formatting to ensure consistency across the Effect codebase.
• Use Case: Use when adding new public Effect APIs, fixing existing JSDoc that fails the jsdocs oxlint check, or refining module-level documentation for clarity and compliance.

Quick Start

Use the jsdocs skill to update the JSDoc for the public Effect API in src/Effect.ts to pass the jsdocs oxlint rule.