skills.rest
parisgroup-ai
parisgroup-aiOFFICIAL
Explore all skills by this author →
GitHub

readme-maintenance

Audit and standardize README and AGENTS documentation across monorepo packages.

1|2|Updated Apr 6, 2026
Search Tags:#automation#documentation#audit#readme#agents#monorepo#link-validation
One-click install
npx skills add https://github.com/parisgroup-ai/imersao-ia-setup --skill readme-maintenance
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-maintenance
Source: https://github.com/parisgroup-ai/imersao-ia-setup/tree/main/skills/readme-maintenance
Command: npx skills add https://github.com/parisgroup-ai/imersao-ia-setup --skill readme-maintenance

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, and includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about readme-maintenance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit and standardize README files across a monorepo?▼

You can generate README templates by reading package.json metadata and source exports to create new README files that enforce a consistent structure using repository templates across all monorepo packages.

How do I validate internal markdown links and documented commands in my documentation?▼

Validating internal markdown links and commands involves parsing markdown links and checking cross-references against package.json and source code to verify documented commands and prevent broken links in your documentation.

Can I use this documentation audit tool for monorepos with multiple packages and apps?▼

This tool requires the jq dependency and access to package.json files to parse metadata, run validation scripts, and produce a standardized report and generated README files.

What is the best way to prevent documentation drift between code and docs before a release?▼

Preventing documentation drift before a release requires running a full audit to ensure all package READMEs document exports, scripts, and usage examples, auto-generating missing documentation for internal packages.

Related Skills

Explore More Software Engineering Skills→
tylerjrbuelltylerjrbuell
21

validate-build

Validate TypeScript monorepo packages against project specifications and build rules.

Community
Advanced
venhdevvenhdev

agents-validator

Validate CLAUDE.md and AGENTS.md structural and content requirements in project directories.

Community
Intermediate
pohlai88pohlai88

pnpm-workspace

Define pnpm-workspace.yaml and link local packages with the workspace protocol.

Community
Intermediate
bordenetbordenet
8

link-verification

Validate and verify Markdown links in documentation before publishing.

Community
Advanced