ZIO Product Knowledge
Core Principles
- Accuracy over memory — Do not rely on training data for ZIO specifics. Fetch the relevant documentation page before answering.
- LLM sitemap first — Start at
https://zio.dev/llms.txtto discover the current documentation structure and pick the right page for your specific question. - Source everything — Include the documentation URL in your response so the user can verify and learn more.
- Right resource first — Navigate from the sitemap to the specific reference page rather than answering from the generic overview.
- Prefer Markdown pages — Always fetch the
.mdversion of a documentation URL first. Fall back to the regular HTML website page only if the.mdfetch fails or returns an error.
Question Routing
Any ZIO question?
→ Start at the LLM sitemap, then navigate to the relevant page:
- ZIO LLM Sitemap: https://zio.dev/llms.txt
The sitemap follows the llmstxt.org standard and lists every documentation page with its URL and a one-line description. Read it to identify the most relevant page(s) for your question, then fetch those pages for API details, types, and method signatures. The URLs end with .md, which means they are Markdown files, and you can read their raw content.
If you need to reduce API calls or want to index the full documentation locally for the session, download the complete content in one request:
- Full Documentation (single file): https://zio.dev/llms-full.txt
This file contains the concatenated content of every documentation page — useful for answering multiple questions across sections or indexing the full documentation locally.
Response Workflow
- Identify the topic — effects? fibers? concurrency? streams? testing? dependency injection? error handling? one of the ecosystem libraries?
- Fetch the sitemap at
https://zio.dev/llms.txtand scan for the relevant section(s). - Navigate to the specific page(s) listed in the sitemap — do not answer from memory. Fetch the
.mdURL directly; fall back to the HTML page only if the.mdfetch fails. - Provide the answer with the source URL so the user can read more.
- If uncertain — direct the user to the official docs: "For the most current information, see https://zio.dev"
Quick Reference
LLM Sitemap (start here for any ZIO question):
Official Documentation:
GitHub Repository:
Maven Central:
Examples Directory (GitHub):
Common Failures
WebFetch returns 404 for a zio.dev/... URL
Page was renamed or removed in a recent docs refresh. Re-fetch the sitemap (https://zio.dev/llms.txt), search for the topic, and navigate to the new URL.
Sitemap fetch itself fails
Network outage, or the docs site is being deployed. Retry once; if it persists, fall back to https://github.com/zio/zio (the source is the ground truth) and the README.
Topic isn't in the sitemap
Either the topic is too narrow for a doc page, or it's covered under a broader umbrella. Search the examples directory and the source under https://github.com/zio/zio/tree/main/zio/src/main/scala/zio.
Doc page contradicts your training data
Training cutoff is older than the docs site. Trust the docs site, not training data. Cite the page in the answer so the user can verify.
Multiple pages cover the same topic
One is the canonical doc and others are older guides or blog posts. Prefer the page under zio.dev over external links; cite both if they materially differ.