readme-verify

Official

Rigorous five-gate README verification.

Authorgetkyo
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Three-gate verification for a finalized README: companion script structural check, chunk-by-chunk forward-reference walk, and skim-reader persona walkthrough with a line-grounded spine test.

Core Features & Use Cases

  • Five-gate verification pipeline covering doctest, companion script, forward-reference walk, skim-reader persona, and catalog-detection signals.
  • Detects structural, content, and surface issues; reports findings for remediation.
  • Use Case: QA teams or maintainers ensure READMEs remain accurate and navigable across modules.

Quick Start

Run Gate 0 doctest, then Gate 1 script checks to validate a README against the five gates.

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: readme-verify
Download link: https://github.com/getkyo/kyo/archive/main.zip#readme-verify

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 510,000+ vetted skills library on demand.