How do I install the Readmes skill?

Run npx skillmds@latest add majiayu000/readmes in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Readmes skill do?

Check all READMEs for accuracy and consistency across the meta-repo It is listed under Coding & Dev Tools on SkillMD.

Is Readmes safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Readmes?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Readmes free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Readmes?

majiayu000 (@majiayu000) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Readmes by majiayu000 — Agent Skill

Name: Readmes
Rating: 4.666666666666667 (3 reviews)
Author: majiayu000

File contents

/readmes

Comprehensive review and update of all README.md files in the meta-repo.

Usage

/readmes    # Review all READMEs in ideas/ directory

Scope

Includes:

ideas/[project]/README.md - All project overviews
ideas/[project]/apps/*/README.md - Multi-app project READMEs
Root-level documentation files

Excludes:

spaces/ directory (code repos have their own maintenance)
Build artifacts, node_modules, etc.

Execution Flow

1. Discover All READMEs

Glob: ideas/**/README.md

2. Review Each README

For each README, technical-writer agent checks:

Status accuracy: Matches CLAUDE.md Current Projects?
Date accuracy: Is "Last Updated" current?
Link validity: Are all links working?
Content completeness: Required sections present?
Consistency: Formatting matches standards?

3. Update READMEs

Fix outdated status indicators
Update dates to current date
Fix broken links
Add missing sections
Standardize formatting

4. Report Results

Summary includes:

READMEs reviewed (count)
Updates made (list of files)
Issues requiring manual attention

What Gets Checked

Aspect	Validation
Status	Matches CLAUDE.md
Dates	"Last Updated" is accurate
Links	Internal refs work
Structure	Has required sections
Consistency	Follows template

When to Use

After major project updates
Before project reviews/demos
Monthly documentation maintenance
After status changes in CLAUDE.md

Notes

Read then write: Agent reads each file before making changes
Preserves content: Only updates metadata and known sections
Non-destructive: Doesn't remove custom content
Idempotent: Safe to run multiple times

Integration

Update CLAUDE.md status → /readmes → Verify changes

---name: readmesdescription: Check all READMEs for accuracy and consistency across the meta-repo--- # /readmes Comprehensive review and update of all README.md files in the meta-repo. ## Usage ```bash /readmes # Review all READMEs in ideas/ directory ``` ## Scope **Includes:** - `ideas/[project]/README.md` - All project overviews - `ideas/[project]/apps/*/README.md` - Multi-app project READMEs - Root-level documentation files **Excludes:** - `spaces/` directory (code repos have their own maintenance) - Build artifacts, node_modules, etc. ## Execution Flow ### 1. Discover All READMEs ```bash Glob: ideas/**/README.md ``` ### 2. Review Each README For each README, technical-writer agent checks: - **Status accuracy**: Matches CLAUDE.md Current Projects? - **Date accuracy**: Is "Last Updated" current? - **Link validity**: Are all links working? - **Content completeness**: Required sections present? - **Consistency**: Formatting matches standards? ### 3. Update READMEs - Fix outdated status indicators - Update dates to current date - Fix broken links - Add missing sections - Standardize formatting ### 4. Report Results Summary includes: - READMEs reviewed (count) - Updates made (list of files) - Issues requiring manual attention ## What Gets Checked | Aspect | Validation | |--------|------------| | **Status** | Matches CLAUDE.md | | **Dates** | "Last Updated" is accurate | | **Links** | Internal refs work | | **Structure** | Has required sections | | **Consistency** | Follows template | ## When to Use - After major project updates - Before project reviews/demos - Monthly documentation maintenance - After status changes in CLAUDE.md ## Notes - **Read then write**: Agent reads each file before making changes - **Preserves content**: Only updates metadata and known sections - **Non-destructive**: Doesn't remove custom content - **Idempotent**: Safe to run multiple times ## Integration ``` Update CLAUDE.md status → /readmes → Verify changes ```

Frequently asked questions

Readmes