Docs Data Type Ref
Write reference documentation for a specific ZIO data type. Research the type, write comprehensive documentation with examples, verify mdoc compilation, and integrate into docs.
Install
$ agentstack add skill-zio-zio-skills-docs-data-type-ref ✓ scanned · ✓ verified, works with Claude Code, Cursor, and more.
Security review
✓ PassedNo issues found. Passed automated security review. · v0.1.0 How review works →
- ✓ Prompt-injection patterns
- ✓ Secret / credential exfiltration
- ✓ Dangerous shell & filesystem operations
- ✓ Untrusted network calls
- ✓ Known-malicious package signatures
What it can access
- ✓ Network access No
- ✓ Filesystem access No
- ✓ Shell / process execution No
- ✓ Environment & secrets No
- ✓ Dynamic code execution No
From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.
Verified badge
Passed review? Show it. Paste this badge into your README, it links to the public security report.
Links to your public security report.[](https://agentstack.voostack.com/security/report/skill-zio-zio-skills-docs-data-type-ref) Reliability & compatibility
Declared compatibility
Compatibility is declared by the source manifest. End-to-end runtime verification is coming, see below.
We're building live execution health for every listing: tool-call success rate, median latency, uptime, and last-checked timestamps, measured, not self-reported. It isn't live yet, so we don't show numbers we can't stand behind.
How agent discovery & health will work →About
Data Type Reference: Conceptual Overview
A data type reference page is task-independent, comprehensive API documentation for a single ZIO type. It is not a tutorial (teaching concepts) or how-to guide (achieving a goal) — it documents everything about one type for practitioners who need authoritative API details.
Core Properties
- Documents every public method on the type and its companion object
- All code examples compile with zero mdoc errors
- Precise section order — readers navigate by scanning headings, so sequence matters
- No duplication — each method appears exactly once
Section Structure
- Opening Definition — NO heading, immediately after frontmatter; type signature + key properties + plain
scalastructural shape - Motivation / Use Case (if applicable) — problem + why this type solves it
- Quick Showcase — 1–3 examples in a single
mdoc:resetblock showing core capabilities - Installation (if applicable) —
libraryDependenciesfor top-level module types - Construction / Creating Instances — all factory methods, smart constructors, conversions
- Predefined Instances (if applicable) — variants, constants in a table or block
- Core Operations — grouped methods: Element Access, Transformations, Combining, Querying, Conversion
- Subtypes / Variants (if applicable) — when to use each, how to create, differing operations
- Comparison (if applicable) — contrast with Java/Scala stdlib equivalents
- Advanced Usage (if applicable) — composition with other types
- Integration (high-confidence only) — only when non-trivial cross-module wiring with a runnable example
- Running the Examples (when standalone examples exist)
mdoc Conventions
- Method signatures: plain
scalablock (no mdoc) - Usage examples:
mdoc:resetblock - Setup + output in a single block — never split
- No blank lines between consecutive code blocks
Quality Gate
Every method documented, zero mdoc compilation errors, frontmatter id matches filename.
Source & license
This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.
- Author: zio
- Source: zio/zio-skills
- License: Apache-2.0
Install and usage instructions live in the source repository linked above.
Reviews
No reviews yet, be the first.
Write a review
Versions
- v0.1.0 Imported from the upstream source.