readme-config

Generate and validate monorepo root README.md files with repository-type templates.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/metasaver/claude-marketplace --skill readme-config
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-config
Source: https://github.com/metasaver/claude-marketplace/tree/main/plugins/metasaver-core/skills/config/workspace/readme-config
Command: npx skills add https://github.com/metasaver/claude-marketplace --skill readme-config

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides README.md templates and validation logic to ensure monorepo root READMEs meet standards.

Core Features & Use Cases

  • Repository-type awareness: Library vs consumer templates.
  • Structured sections: Title, Overview, Quick Start, Commands, Docs links.
  • Validation scaffolding: Quick checks for required sections and links.

Quick Start

Use the templates to generate or audit README.md at the repository root.

Frequently Asked Questions about readme-config

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

FAQPage Schema
How do I keep README.md consistent across a monorepo?

README consistency in monorepos is maintained through templates and validation logic that enforce standardized structure at the repository root. This Skill provides repository-type-aware templates—distinguishing library from consumer projects—and validation scaffolding to audit required sections, ensuring all monorepo READMEs meet the same documentation standards and content guidelines.

What sections should a monorepo root README include?

A well-structured monorepo root README includes Title, Overview, Quick Start, Commands, and Documentation links sections. This Skill provides templates that enforce these structured sections and offer content-length guidance, ensuring documentation completeness and navigability for users and contributors.

Can I validate my existing README.md against documentation standards?

Yes. This Skill includes validation scaffolding that audits existing README.md files for required sections, proper links, and content completeness. It checks whether your repository is correctly identified as a library or consumer project and flags gaps against the template structure.

How do I generate a README template for a library versus a consumer monorepo?

This Skill detects your repository type—library or consumer—and applies the appropriate template. Library templates and consumer templates differ in emphasis and content structure, allowing you to generate tailored README.md files that match your project's actual purpose and audience.

What's the best way to audit documentation quality in a monorepo root?

Automated validation checks the monorepo root README for required sections, consistent formatting, and adequate link coverage. This Skill performs these audits against predefined templates, identifying documentation gaps and inconsistencies without manual review.

Do I need to manually maintain README templates across multiple projects?

No. This Skill centralizes template management and validation for monorepo roots, eliminating manual synchronization. Once templates are applied and validation rules are set, the Skill ensures ongoing consistency across your monorepo without duplicated effort per project.