readme-maintenance
OfficialKeep READMEs consistent and up-to-date
Authorparisgroup-ai
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Maintain consistent, accurate, and discoverable README.md and AGENTS.md documentation across a monorepo to reduce onboarding friction, prevent broken links, and avoid drift between code and docs.
Core Features & Use Cases
- Audit and Report: Scan packages and apps to detect missing or outdated README and AGENTS files and generate an actionable audit report.
- Generate and Standardize: Create new README files from package metadata and source exports using repository templates to enforce a consistent structure.
- Validate Links and Commands: Verify internal markdown links, documented commands, and cross-references against package.json and source code.
- Use Case: Run a full audit before a release to ensure all package READMEs document exports, scripts, and usage examples and to auto-generate missing documentation for internal packages.
Quick Start
Request the audit by running the readme skill with the command /readme audit to produce a report of missing, inconsistent, and broken documentation.
Dependency Matrix
Required Modules
jq
Components
scriptsreferences
💻 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-maintenance Download link: https://github.com/parisgroup-ai/imersao-ia-setup/archive/main.zip#readme-maintenance Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.