skills.rest
rejifald
rejifaldCOMMUNITY
Explore all skills by this author →
GitHub

sync-readme

Synchronize README.md with marketing i18n files, monorepo structures, and CI metrics.

19|Updated May 27, 2026
Search Tags:#automation#documentation#validation#readme#monorepo#sync
One-click install
npx skills add https://github.com/rejifald/movar --skill sync-readme-rejifald
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sync-readme
Source: https://github.com/rejifald/movar/tree/main/.agents/skills/sync-readme
Command: npx skills add https://github.com/rejifald/movar --skill sync-readme-rejifald

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill resolves the common issue of documentation drift where the README.md file becomes outdated compared to the actual codebase, marketing copy, and project metrics.

Core Features & Use Cases

  • Parity Guard: Automatically validates the README against the marketing hero tagline, monorepo layout, and product promises.
  • Metrics Synchronization: Updates the generated badge block to reflect current code health, test coverage, and license status.
  • Use Case: After adding a new package to the monorepo or updating the marketing tagline, use this Skill to ensure the README remains a reliable and accurate source of truth without manual editing.

Quick Start

Run the sync-readme skill to validate the current README against the project sources and apply any necessary auto-fixes.

Frequently Asked Questions about sync-readme

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

FAQPage Schema
How do I automate README synchronization with monorepo sources?▼

Automate README synchronization by running internal TypeScript scripts that validate your README.md against marketing i18n files, monorepo directory structures, and CI-generated metrics to ensure documentation parity.

Why does my README documentation drift from the actual codebase?▼

README documentation drifts when project sources change without manual updates. This Skill resolves documentation drift by automatically validating the README against canonical sources like marketing copy and CI metrics.

What's the best way to update README badges with current code metrics?▼

Update README badges by synchronizing the generated badge block with CI-generated metrics. This Skill automatically updates code health, test coverage, and license status badges to reflect current project metrics.

Does this README validation work with i18n marketing files?▼

Yes, README validation works with i18n marketing files. The Parity Guard feature automatically validates your README against the marketing hero tagline and product promises stored in i18n files.

How do I validate README layout integrity after refactoring a monorepo?▼

Validate README layout integrity after refactoring by running sync-readme scripts. These scripts verify taglines, layout integrity, and product promise invariants against the updated monorepo directory structure.

Can I auto-fix an outdated README without manual editing?▼

Yes, you can auto-fix an outdated README without manual editing. The Skill applies necessary auto-fixes to ensure the README remains a reliable and accurate source of truth after running its validation scripts.

Related Skills

Explore More Software Engineering Skills→
openakitaopenakita
2.0k

generate-agents-md

Generates standardized AGENTS.md files for AI coding agent projects.

Community
Intermediate
madeinoz67madeinoz67
3

release

Synchronize version numbers across project files and create Git tags.

Community
Advanced
ianyimiianyimi
1

Global Coding Style

Enforce global coding style guidelines across multi-language codebases.

Community
Basic
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate