legibility-check

Featured

Validate maintainer docs structure, standards freshness, manifest paths, and plan state. Run this after modifying any file under .agents/docs/standards/, .agents/docs/plans/, .agents/docs/architecture/, or AGENTS.md — it catches stale metadata, broken manifest paths, and plan state drift before CI does.

AI & Automation 3,113 stars 267 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 94/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
93
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Legibility Check Run deterministic checks for maintainer docs that mirror what CI enforces via `.github/workflows/legibility.yml`. Catching these locally saves a round-trip to CI. ## What it checks 1. **Standards freshness** — every `.agents/docs/standards/*.md` must have frontmatter with `owner`, `last_reviewed` (ISO date), and `source_of_truth`. Files reviewed more than 60 days ago produce a warning. 2. **Architecture manifest** — every path listed in `.agents/docs/architecture/manifest.yaml` under `expected_paths:` must exist in the repo. 3. **Plan state drift** — every `.agents/docs/plans/**/*.md` must have a `status` frontmatter field (`active`, `completed`, or `cancelled`). Completed plans must not contain unchecked `- [ ]` checkboxes (outside fenced code blocks). ## Run ```bash uv run python scripts/check_legibility.py ``` Options: - `--freshness-days N` — change the staleness threshold (default: 60) - `--strict-freshness` — promote stale warnings to failures - `--repo-root PATH` — override repo root (default: cwd) ## Fixing common failures | Failure | Fix | |---------|-----| | `missing frontmatter key 'X'` | Add the missing key to the YAML frontmatter block at the top of the file | | `last_reviewed must be ISO date` | Use `YYYY-MM-DD` format | | `last_reviewed ... is stale` | Update `last_reviewed` to today's date after reviewing the content | | `expected path missing: X` | Either create the file or remove the stale entry from `manifest.yaml` | | `status mus...

Details

Author
liaohch3
Repository
liaohch3/claude-tap
Created
6 months ago
Last Updated
yesterday
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category