Documentation README Sync

Regenerate README.md from skills.json and agents.json registries in Betty Framework repositories.

2|Updated Oct 22, 2025
One-click install
npx skills add https://github.com/epieczko/betty --skill documentation-readme-sync
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Documentation README Sync
Source: https://github.com/epieczko/betty/tree/main/skills/docs.sync.readme
Command: npx skills add https://github.com/epieczko/betty --skill documentation-readme-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps the repository README.md up to date by pulling current skills and agents from registry files and regenerating sections.

Core Features & Use Cases

  • Reads registry/skills.json and registry/agents.json
  • Categorizes skills by foundation, API, infrastructure, and governance
  • Updates core skills section and agents docs in README
  • Produces a sync report with counts and timestamp

Quick Start

python3 skills/docs.sync.readme/readme_sync.py

Frequently Asked Questions about Documentation README Sync

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

FAQPage Schema
How do I keep my README automatically synced with skill and agent registries?

Documentation README Sync reads registry/skills.json and registry/agents.json files, categorizes skills by type, and regenerates README.md sections with updated markdown tables and agent lists. It preserves existing structure while pulling current registry data, ideal for Betty Framework repositories.

What does the sync report show after updating the README?

The Skill generates sync_report.json containing skill and agent counts, categorization results, and a timestamp of when the sync ran. This report documents what changed and when, making it easy to track registry updates over time.

Can I automate README updates whenever my registry files change?

Yes. Documentation README Sync is designed to run automatically when registry/skills.json or registry/agents.json updates, regenerating README.md sections without manual intervention or additional tooling required.

How does the Skill categorize skills in the README?

It reads the registry JSON, organizes skills into four categories—foundation, API, infrastructure, and governance—then formats each group into markdown tables with consistent structure for clear documentation organization.

What happens to existing README content outside registry sections?

The Skill preserves existing README structure and content outside the registry-managed sections. Only sections for core skills, agents documentation, and documentation references are updated, keeping custom content intact.