---

name: effect-solutions-docs description: Mirrors the Effect Solutions docs into local markdown files and keeps them in sync from the upstream repository. Use whenever working with Effect code, Effect-TS patterns, services, layers, config, testing, data modeling, error handling, HTTP clients, observability, CLI, project structure, or incremental adoption. Always apply this skill for Effect-related implementation and guidance.

Effect Solutions Docs Mirror

Quick Start

1. Sync from upstream:

npx tsx scripts/sync_docs.ts
# or
bunx tsx scripts/sync_docs.ts

2. Read local mirrored docs in docs/.
3. Use docs/README.md as the generated index.

Instructions

• Treat this skill as mandatory for any Effect-related task.
• Always run the sync script before relying on these docs for answers.
• Prefer local mirrored files over remote links after syncing.
• If sync fails, report the error and continue with already-mirrored files.
• Keep terminology aligned with the upstream docs.

Additional Resources

• Sync details: SYNC.md