Sync Readme — Documentation skill for Claude Code
Regenerate README.md and docs/categories/ from .claude-plugin/marketplace.json.
How to install Sync Readme
Installs to ~/.claude/commands/shotcowboystyle-ai-plugins-sync-readme.md
mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/shotcowboystyle/ai-plugins/HEAD/.claude/commands/sync-readme.md -o ~/.claude/commands/shotcowboystyle-ai-plugins-sync-readme.md Restart Claude Code, or start a new session, for it to be picked up.
What Sync Readme does
Regenerate `README.md` and `docs/categories/` from `.claude-plugin/marketplace.json`.
The catalogue is **generated, not hand-edited**. Run:
python3 scripts/generate-catalogue.py
That rewrites the `## Available Plugins` block of `README.md` (everything between that heading and `## Installation`) and regenerates every page under `docs/categories/`. Everything else in `README.md` is hand-maintained and the script leaves it alone.
The script requires every plugin entry to carry `disp
Alternatives in Documentation
- Doc Co-authoring — Guide users through structured workflow for co-authoring documentation 94.1k ★
- OpenAI Docs — Provide authoritative guidance from OpenAI developer documentation 14.6k ★
- Documentation Sync — Check if documentation matches the current code state 5.8k ★
Full documentation available on GitHub
View Source RepositoryRelated Skills
Doc Sync
Reconcile docs + regenerate dashboard screenshots after doc-relevant code or ADR changes
Pub Ws
Publish ws plugin to marketplace with version bump, changelog update, and git sync
Refresh Docs
Regenerate documentation from code sources of truth
Wiki Status
Show karpathy-wiki health report (categories, counts, drift, quality, last ingest)
Sync Public Docs
Sync public VitePress documentation (docs/) with code changes — run before release or periodically on feature
Fec Doc Sync
Sync README, docs, environment variables, scripts, API/routing/component descriptions and deployment instructi
Related Agents
Marketplace Sync
Validates and synchronizes marketplace.json AND README.md with all plugin changes. Use PROACTIVELY after creat
Version Checker
Checks version, generated references, public docs, and metadata sync. Use proactively after version bumps, rel
Docs Sync
Updates the living specifications (RSM_, TD32_FORMAT_NOTES, DAP_DEBUGGER_ARCHITECTURE, KNOWN_UNKNOWNS, TRAPS,