jsdocs

Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.

Install
npx skills add 'https://github.com/Effect-TS/effect/tree/main/.agents/skills/jsdocs'
Download bundle ↓
main · 90695b0Scanned 2026-09-15

Contributors

GitHub-linked commit authors for this SKILL.md at the saved revision. Co-authors and history before file renames are not included.

File history ↗

categories.md

categories.mdBrowse 4 files
View on GitHub
← Back to SKILL.md

Categories

Root declarations require one non-empty @category. Reuse nearby categories; prefer lowercase plurals and gerunds while preserving canonical domain casing.

Common categories include:

  • Shapes: constructors, destructors, models, schemas, guards, predicates, getters, accessors, instances, constants, protocols, prototypes, re-exports, unsafe, testing.
  • Effect: services, tags, layers, context, resource management, running, errors, error handling.
  • Operations: combinators, filtering, mapping, sequencing, zipping, combining, merging, converting, transforming, folding, splitting, repetition.
  • Shared: utility types, encoding, decoding, serialization, tracing, metrics, logging, annotations, references, symbols, type IDs, configuration, math, comparisons, ordering.

Keep these boundaries: services are contracts, tags identify services, and layers provide them; getters retrieve values while accessors read context; errors model failures while error handling recovers or maps them; models are domain data while utility types are type-level contracts; guards narrow while predicates return booleans.

Referenced from SKILL.md