skills.rest
yu-iskw
yu-iskwCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Maintain README

Synchronize README.md plugin tables and documentation links from manifests.

3|Updated Feb 13, 2026
Search Tags:#automation#documentation#readme#monorepo#sync#plugin management
One-click install
npx skills add https://github.com/yu-iskw/dbt-heros --skill maintain-readme
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Maintain README
Source: https://github.com/yu-iskw/dbt-heros/tree/main/.claude/skills/maintain-readme
Command: npx skills add https://github.com/yu-iskw/dbt-heros --skill maintain-readme

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill ensures that the list of available plugins and their documentation links in your project's main README file are always accurate and synchronized with the actual files in your repository.

Core Features & Use Cases

  • Automated Plugin Table Generation: Scans plugin manifests (.claude-plugin/plugin.json) to build an up-to-date Markdown table of plugins.
  • Documentation Link Synchronization: Creates a list of links to documentation files found in docs/plugins/.
  • Use Case: After adding a new plugin or updating a plugin's description, run this skill to automatically refresh the main README, ensuring users always see the correct information.

Quick Start

Update the plugin list and documentation links in the README file.

Frequently Asked Questions about Maintain README

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

FAQPage Schema
How do I automatically update README plugin lists in a monorepo?▼

Automatically update README plugin lists in a monorepo by scanning the plugins/ directory for .claude-plugin/plugin.json manifests and regenerating the Markdown tables. This ensures your plugin documentation links stay synchronized with the actual repository files.

How does documentation synchronization work for plugin manifests?▼

Documentation synchronization for plugin manifests works by scanning the docs/plugins/ directory for .md files and matching them with available plugin.json configurations. It then regenerates the links and tables in the root README.md file using StrReplace to update specific markers.

What is the best way to keep a README table up-to-date with new plugins?▼

The best way to keep a README table up-to-date with new plugins is to run an automated synchronization skill that scans your plugin manifests and documentation files. This regenerates the Markdown tables and lists in the root README.md file to reflect the current repository state.

Do I need specific markers in README.md to automate plugin list generation?▼

Yes, you need specific markers in README.md to automate plugin list generation because the synchronization process uses StrReplace to update those exact markers. Without these defined markers, the tool cannot locate and replace the old plugin tables and documentation links.

Can I use this README sync tool for repositories without a docs/plugins directory?▼

No, you cannot use this README sync tool for repositories without a docs/plugins directory because the core logic specifically scans that location for .md files to build documentation links. It also requires a plugins/ directory containing .claude-plugin/plugin.json manifests to function properly.

Related Skills

Explore More Software Engineering Skills→
devrelaicomdevrelaicom
37

midnight-plugin-utils:dependency-scanner

Scan Claude plugin source files for external dependency references.

Official
Intermediate
dlt-hubdlt-hub
53

validate-toolkits

Validate AI toolkit integrity by checking URLs, cross-references, and documentation sync.

Official
Advanced
012e012e
1

nx-generate

Generate code scaffolding and migrations using Nx generators in a monorepo.

Community
Advanced
georgekhananaevgeorgekhananaev
27

md

Enforce consistent Markdown syntax across documentation and README files.

Community
Basic