Effect v4 AI Documentation

Effect-TS/effect-smol ships a curated, agent-facing documentation directory at ai-docs/. It contains real-world-usage TypeScript examples with @title JSDoc blocks, organized by topic and ordered with numeric filename prefixes. Run pnpm ai-docgen in the Effect repo to regenerate LLMS.md (the assembled artifact).

Where to look

Effect-TS/effect-smol is vendored in the consuming project at repos/effect/ via git subtree. Two relevant entry points:

• LLMS.md — assembled doc (~329 lines). Best for whole-library lookups, idiom hunts, "how does Effect do X" questions where you don't yet know which module to consult.
• ai-docs/src/ — source of truth, organized by topic. Best for deep dives into one area (each .ts file is one focused example with comments explaining the why).

When LLMS.md is missing or stale, the user can regenerate it from the consuming project root: cd repos/effect && pnpm ai-docgen.

Topic index

ai-docs/src/ is organized by numeric-prefixed topic dirs: