api-docs_skill

Overview

This skill lets you quickly locate and extract API documentation from the official Effect-TS docs at https://effect-ts.github.io/effect/. It targets specific modules and functions so you can get function signatures, parameter descriptions, usage examples, and related APIs without manual browsing. Use it when you need authoritative API details or code examples for Effect, Schema, Stream, Layer, and other Effect-TS modules.

How this skill works

The skill maps a requested symbol (like Effect.retry or Schema.Struct) to the corresponding documentation page and constructs the module URL pattern. It issues a targeted WebFetch prompt to the page asking for the function signature, parameters, description, and examples. The result is a concise, focused extraction of the relevant API details and related links.

When to use it

• You need a function signature or overloads for an Effect-TS API (e.g., Effect.map, Effect.retry).
• You want parameter explanations and option names for a specific API call.
• You need usage examples or code snippets from the official docs.
• You want an overview of available functions in a module (Stream, Schema, Layer, etc.).
• You want to find related functions (e.g., all catch* error handlers) or combinators.

Best practices

• Identify the module that likely contains the symbol (Effect.ts, Schema.ts, Stream.ts) before fetching.
• Use a precise prompt: request signature, parameters, and one or two concise examples.
• Check for overloads and 'Since' annotations to ensure API compatibility with your version.
• Follow 'See also' links in the extracted doc to discover related APIs.
• When unsure which module, start from the main index https://effect-ts.github.io/effect/ to find package/module names.

Example use cases

• User asks: 'What is the signature and usage of Effect.retry?' — fetch Effect.ts and extract retry details.
• User asks: 'How do I use Schema.transform?' — fetch Schema.ts and return signature, parameter meanings, and examples.
• User asks: 'List main functions in Stream module.' — fetch Stream.ts and summarize categories and key functions.
• User asks: 'What catch* functions are available in Effect?' — fetch Effect.ts and list catchAll, catchSome, catchTag, etc., with signatures.
• User asks: 'Where is HttpClient documented in @effect/platform?' — fetch platform/HttpClient.ts.html and extract API details.