skills.rest
zio
zioOFFICIAL
Explore all skills by this author →
WebsiteGitHub

write-data-type-ref

Generate a complete API reference page for a ZIO Blocks data type.

139|173|Updated Mar 28, 2025
Search Tags:#documentation#reference#scala#api-reference#mdoc#zio-blocks#type-ref
One-click install
npx skills add https://github.com/zio/zio-blocks --skill write-data-type-ref
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-data-type-ref
Source: https://github.com/zio/zio-blocks/tree/main/.claude/skills/write-data-type-ref
Command: npx skills add https://github.com/zio/zio-blocks --skill write-data-type-ref

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about write-data-type-ref

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an API reference page for a Scala data type?▼

An API reference page for a Scala data type is generated by extracting type signatures, public members, and companion objects from source files. The tool then composes a structured page with sections for motivation, construction, operations, and integration.

What is included in a ZIO data type reference page?▼

A ZIO data type reference page includes an opening definition, motivation, construction methods, core operations, and integration sections. It extracts public members, companion objects, tests, and related docs to provide a thorough narrative with cross-references.

Can I validate generated Scala documentation against mdoc constraints?▼

Yes, generated Scala documentation is validated against mdoc constraints. The tool delivers mdoc-compile-checked code blocks within the front-matted page, ensuring that all code examples compile correctly and maintain documentation consistency.

Does this documentation tool work with ZIO Blocks source and test files?▼

Yes, this documentation tool works with ZIO Blocks by extracting type signatures, public members, and tests directly from source, test, and example files. It uses this data to compose a complete and accurate API reference page.

What is the best way to automate ZIO API reference documentation creation?▼

The best way to automate ZIO API reference documentation creation is to provide a fully-qualified type name to this generation tool. It reduces manual drafting by automatically extracting definitions and structuring the page with mdoc-checked examples.

Related Skills

Explore More Software Engineering Skills→
JonathanMitchell1234JonathanMitchell1234

scala-expert

Provide expert guidance on Scala, functional programming, and Akka reactive systems.

Community
Advanced
TheBushidoCollectiveTheBushidoCollective
187

documentation-linking

Establish bidirectional links between code and documentation with multiple link formats.

Official
Basic
JCE-Joshhh77JCE-Joshhh77
16

scala

Guide Scala toolchain, framework, and design pattern selection for projects.

Community
Advanced
getkyogetkyo
807

readme-analyze-source

Scan module source trees to produce spine candidates and API surface inventories.

Official
Advanced