/docs and /docs-v4 commands let you look up API documentation for Effect modules and functions without leaving Discord. Results are displayed as rich embeds with the type signature, description, examples, and a source link.
/docs— searches the Effect v3 documentation./docs-v4— searches the Effect v4 / effect-smol documentation.
Usage
Parameters
The search term. Autocomplete activates after you type at least 3 characters, returning up to 25 fuzzy-matched results. Select a result from the dropdown to submit the exact entry.
Controls the visibility of the response.
true— the embed is posted publicly so everyone in the channel can see it.false— the embed is sent as an ephemeral message visible only to you.
Autocomplete behavior
As you type in thequery field, the bot performs a fuzzy search over the loaded documentation index. Autocomplete results are formatted as:
Autocomplete requires a minimum of 3 characters. Typing fewer than 3 characters returns no suggestions.
Result embed
Each result embed includes the following fields:| Field | Description |
|---|---|
| Author | The npm package name (e.g., effect, @effect/platform) |
| Title | Module.functionName |
| Description | The JSDoc description for the function or type |
| Type signature | Formatted TypeScript signature in a ts code block |
| Examples | Code examples from the JSDoc, if present |
| Source link | A link to the exact line in the source file |
| Footer | Added in v{version} |
Difference between /docs and /docs-v4
| Command | Documentation source |
|---|---|
/docs | Effect v3 (effect, @effect/* packages) |
/docs-v4 | Effect v4 / effect-smol |