doc

Audit documentation gaps across blocks, examples, and newsletters.

Updated Mar 25, 2026
One-click install
npx skills add https://github.com/zeveck/zskills --skill doc-zeveck
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc
Source: https://github.com/zeveck/zskills/tree/main/skills/doc
Command: npx skills add https://github.com/zeveck/zskills --skill doc-zeveck

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit and fix documentation gaps across blocks, examples, newsletters, and related project artifacts.

Core Features & Use Cases

  • Comprehensive audits of block registrations, explorer data, and example models
  • Generates missing READMEs, gallery entries, and newsletters
  • Centralized guidance for maintaining documentation health across the project

Quick Start

Use the /doc command to audit recent changes and fill missing documentation

Frequently Asked Questions about doc

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

FAQPage Schema
How do I audit missing READMEs and gallery entries across project blocks?

To audit missing READMEs, run the /doc command to scan block registrations, explorer metadata, and example model galleries. It identifies missing documentation entries and generates the required files to fill structural gaps across the project.

What is the best way to enforce frontmatter validity and cross-link integrity in documentation?

Enforcing frontmatter validity and cross-link integrity is handled by scanning block artifacts for consistent structure. The audit checks metadata fields and internal links, flagging invalid entries and broken references without executing any project code.

Can I generate missing newsletters and documentation artifacts for a Block Registry automatically?

Yes, you can generate missing newsletters and documentation artifacts automatically. The audit detects absent files within the Block Registry and Explorer metadata, then creates compliant READMEs and newsletter entries to maintain project health.

Does the documentation audit work without executing code from the example models?

The documentation audit works strictly without executing code. It evaluates static text, frontmatter fields, and cross-link references across example models and related artifacts to ensure compliance without triggering runtime scripts.

How do I fix documentation gaps for recent changes in a block-registry project?

Fix documentation gaps for recent changes by running the /doc command. It audits the latest block additions, identifies missing READMEs or Explorer entries, and applies structural fixes to align the new artifacts with existing standards.