Document Effect Public APIs
When to Use
Write or review Effect public JSDoc against declaration, implementation, call-site and doctest evidence.
Workflow
Read the declaration, implementation, public types and real call sites. Follow the project's current tags, categories and example rules. Write a practical description and add usage, details or concrete gotchas where needed. Audit links and related APIs. Compile runnable examples through the targeted doctest and run the repository's JSDoc checker. Keep internal or unsupported declarations out of public API docs.
Example
Document a public combinator with one runnable error-handling example and a verified link to its nearest alternative.
Limitations
Requires the relevant Effect workspace and its versioned tools. Use local project policy and authorized fixtures. Results cover only the checked packages and environments.
Bundled resources
Use the bundled local references for the applicable branch of the workflow: categories, declarations, examples. Run commands against the target Effect workspace.
Source
Adapted from the pinned skill tree. See the MIT license.
This snapshot of Effect v4 is vendored by Local Studio.