Skip to content
cccskills
FreePublished on GitHub

legibility-check

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.

The English summary is being prepared. Showing the original description.

See how to install

Files included (1)

  • SKILL.md2.2 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

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

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

FailureFix
missing frontmatter key 'X'Add the missing key to the YAML frontmatter block at the top of the file
last_reviewed must be ISO dateUse YYYY-MM-DD format
last_reviewed ... is staleUpdate last_reviewed to today's date after reviewing the content
expected path missing: XEither create the file or remove the stale entry from manifest.yaml
status must be one of [...]Add status: active (or completed/cancelled) to plan frontmatter
completed plan still contains unchecked TODOCheck off remaining items or change status back to active

After fixing

Re-run the check to confirm all issues are resolved before committing:

uv run python scripts/check_legibility.py && echo "All clear"

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Run PR-grade real Codex E2E validation through claude-tap, including resume turns, multiple tool calls, optional image input, viewer verification, and screenshot evidence.

The English summary is being prepared. Showing the original description.

liaohch3/claude-tap3.3KUpdated Oct 21, 2026

Generate demo assets (GIF/MP4) from real tmux E2E runs and viewer screenshots using asciinema and Playwright

The English summary is being prepared. Showing the original description.

liaohch3/claude-tap3.3KUpdated Oct 21, 2026

Run claude-tap end-to-end tests with pytest

The English summary is being prepared. Showing the original description.

liaohch3/claude-tap3.3KUpdated Oct 21, 2026

Test JS logic embedded in HTML using two-layer strategy - Python unit tests + Playwright browser integration tests

The English summary is being prepared. Showing the original description.

liaohch3/claude-tap3.3KUpdated Oct 21, 2026

Record browser test videos with Playwright for PR review and bug fix verification

The English summary is being prepared. Showing the original description.

liaohch3/claude-tap3.3KUpdated Oct 21, 2026

Full pre-PR merge-readiness check. Run this before opening or merging a pull request — it validates local gates (lint, format, tests), CI status, screenshot evidence, and PR metadata in one pass. Also useful for reviewing an existing PR's readiness.

The English summary is being prepared. Showing the original description.

liaohch3/claude-tap3.3KUpdated Oct 21, 2026

See all skills by liaohch3

Report a problem with this skill