Skills
.Work. You
Rest

write-data-type-ref

Official

Generate precise API references for data types.

Software Engineering#documentation#reference#scala#api-reference#mdoc#zio-blocks#type-ref
Authorzio
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Automates the creation of a detailed API reference page for a ZIO Blocks data type, reducing manual drafting and ensuring consistency across docs.

Core Features & Use Cases

  • Extracts the type signature, public members, companion objects, tests, and related documentation
  • Generates a complete Reference Page with an opening definition, motivation, construction, core operations, and integration sections
  • Validates generated content against mdoc constraints and supports cross-linking with existing docs

Quick Start

Provide the fully-qualified type name to generate a complete API reference page.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: write-data-type-ref
Download link: https://github.com/zio/zio-blocks/archive/main.zip#write-data-type-ref

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.