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

finding-undocumented

Scan ZIO Blocks public APIs and generate a prioritized undocumented report.

139|173|Updated Mar 28, 2025
Search Tags:#documentation#docs#report#scala#documentation-scan#module-filtering
One-click install
npx skills add https://github.com/zio/zio-blocks --skill finding-undocumented
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: finding-undocumented
Source: https://github.com/zio/zio-blocks/tree/main/.claude/skills/finding-undocumented
Command: npx skills add https://github.com/zio/zio-blocks --skill finding-undocumented

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill identifies gaps in documentation across the ZIO Blocks project by scanning public APIs, modules, and packages and reporting areas without coverage in the docs directory.

Core Features & Use Cases

  • Automated scan of codebase to surface undocumented public types and modules.
  • Generates a prioritized, TODO-style report saved to docs/undocumented-report.md.
  • Supports optional module filtering to focus on specific areas (e.g., schema, chunk, scope) for targeted improvements.

Quick Start

Follow the scanner to generate docs/undocumented-report.md and review the resulting TODO actions.

Frequently Asked Questions about finding-undocumented

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

FAQPage Schema
How do I find undocumented public types in a Scala project?▼

To find undocumented public types in a Scala project, scan the codebase to surface public APIs and modules lacking docs coverage. This generates a prioritized TODO-style report saved to docs/undocumented-report.md.

What is documentation coverage scanning and how does it work?▼

Documentation coverage scanning identifies gaps by comparing public APIs, modules, and packages against existing docs. It surfaces undocumented areas and generates a prioritized report highlighting where coverage is missing.

Can I filter documentation scans to focus on specific Scala modules like schema or chunk?▼

Yes, you can apply optional module filtering to focus documentation scans on specific areas like schema, chunk, or scope. This narrows the generated report to relevant packages for targeted improvements.

How do I generate a docs coverage report for missing public APIs?▼

Generate a docs coverage report by scanning the codebase for undocumented public APIs and saving the results to docs/undocumented-report.md. The report provides TODO actions and enrichment steps for manual analysis.

What is the best way to prioritize missing documentation across multiple modules?▼

The best way to prioritize missing documentation is generating an automated report that surfaces undocumented public types and modules. The report applies prioritization to systematically address gaps in docs coverage.

What limitations exist when scanning for undocumented packages in a large codebase?▼

Scanning for undocumented packages in a large codebase may require optional module filtering to manage scope. The generated report provides enrichment steps for manual analysis rather than automatic documentation generation.

Related Skills

Explore More Content & Communication Skills→
raphaelchristiraphaelchristi
43

harness:setup

Configure Harness Evolver, LangSmith, and baseline evaluations for Python projects.

Community
Advanced
robertzengcnrobertzengcn

document-generate

Generate Diataxis-aligned documentation for software features, modules, and projects.

Community
Advanced
automagik-devautomagik-dev
328

docs

Audit, generate, and validate documentation against the codebase.

Official
Intermediate
NodeJSmithNodeJSmith
77

doc-coverage-review

Identify user-facing codebase features missing from documentation.

Community
Advanced