skills.rest
Kevin-Mok
Kevin-MokCOMMUNITY
Explore all skills by this author →
Website𝕏@Kev_MokGitHub

readme-recruiter-sync

Validate root README alignment against repository evidence during commit workflows.

Updated Aug 23, 2026
Search Tags:#documentation#verification#readme#sync#gate#repo-evidence#recruiter
One-click install
npx skills add https://github.com/Kevin-Mok/ai-cli-dotfiles --skill readme-recruiter-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-recruiter-sync
Source: https://github.com/Kevin-Mok/ai-cli-dotfiles/tree/main/dot_agents/skills/readme-recruiter-sync
Command: npx skills add https://github.com/Kevin-Mok/ai-cli-dotfiles --skill readme-recruiter-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Keeps the repository root README truthful, runnable, and recruiter-ready by validating alignment during commits or documentation refreshes and flagging drift.

Core Features & Use Cases

  • Grounds every README claim in repo evidence (AGENTS.md, dot_codex/, plans/) and ensures the root README reflects the current state.
  • Verifies required sections against the readme-contract and coordinates safe updates or blockers when drift is detected.
  • Supports gate-style commit workflows by determining whether the README is in a shippable state (pass_no_change, update_in_same_change, or blocked).

Quick Start

Run Readme Recruiter Sync to validate and align the root README with the current repo state.

Frequently Asked Questions about readme-recruiter-sync

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

FAQPage Schema
How do I keep my repository README aligned with the current repo state during commits?▼

To keep your README aligned during commits, run a validation gate that checks root README claims against tracked repo evidence like AGENTS.md, dot_codex/, and plans/ to flag drift before pushing.

What is a recruiter-ready README and how does it stay truthful?▼

A recruiter-ready README is documentation grounded in actual repo evidence rather than stale messaging. It stays truthful by validating required sections against a readme-contract during commit or push workflows.

How do I block a git push if my README documentation is out of sync?▼

You can block a push by implementing a gate-style commit workflow that evaluates README alignment and returns a blocked status when it detects drift between documentation claims and repository evidence.

Does this README validation tool trigger automatically when I change setup flows or plans?▼

Yes, the validation triggers automatically whenever changes touch core areas like AGENTS.md, dot_codex/, plans/, or setup flows, ensuring the root README reflects the current repository state without manual checks.

What is the best way to verify if my README passes a shippable state check?▼

The best way to verify a shippable README state is to validate it against a readme-contract, which reports whether the README passes, needs updates in the same change, or should block the commit entirely.

When should I not use an automated README sync gate?▼

You should avoid an automated README sync gate if your repository lacks tracked evidence files like AGENTS.md or plans/, as the validation requires grounding README claims in existing repo evidence to function correctly.

Related Skills

Explore More Content & Communication Skills→
andreyvitandreyvit
5

zoo-init

Initialize .zoo customization files and verify Bureau MCP access.

Community
Intermediate
ShaheerKhawajaShaheerKhawaja
8

productionos-document-release

Sync shipped code changes with project documentation to correct drift.

Community
Intermediate
alirezarezvanialirezarezvani
763

readme-updater

Automate README updates by parsing diffs and detecting relevant code changes.

Community
Basic
TaylorHustonTaylorHuston
69

validate-idea

Validate idea documentation structure and phase-appropriate artifact readiness.

Community
Basic