readme-showcase-sync
Audit and update Main README (README.md, README.ko.md) and User Project Website (docs/user/index.md, website/) to ensure newly added features, bundled skills, and tools are properly showcased. Use whe
Files2
View on GitHubSKILL.md.agents/skills/readme-showcase-sync/SKILL.md
GitHubREADME & Showcase Sync
Audit the codebase against user-facing showcase surfaces—primarily the Main README (README.md, README.ko.md) and the User Project Website (VitePress Landing & Navigation)—to ensure new features and capabilities are prominently highlighted.
🎯 Purpose
When new features (e.g., Solution Recipes, Scheduled Tasks, Browser Sidecar, Session Export, Bundled Skills like ig-cli) are implemented, internal documentation (docs/user/guides/) is often created, but the front door of the project—the Root README.md and the user-facing project website landing page—lags behind.
This skill automates:
- Detecting features implemented in code but omitted from
README.mdanddocs/user/index.md. - Planning concise, high-impact showcase updates.
- Synchronizing main English & Korean READMEs and VitePress landing pages.
🔄 Workflow
Step 1 — Audit Showcase Surfaces
Run the automated showcase audit script:
python3 .agents/skills/readme-showcase-sync/scripts/audit_showcase.py . --output .libragent/tmp/showcase-audit.json
The script reports:
- Features missing in Main
README.md - Features missing in Korean
README.ko.md - Features missing in Project Website Landing (
docs/user/index.md/en/index.md) - Features missing in VitePress Navigation (
website/.vitepress/config.ts)
Step 2 — Review & Select High-Impact Additions
Filter the audit results by user value:
- P0 Highlights: Core user-facing workflows (e.g.,
recipes,scheduled-tasks,browser-sidecar,session-export,ig-cli). - P1 Capabilities: System/governance features (e.g.,
session-isolation,soul-lounge,compact-planning). - P2 Minor/Dev tools: Can remain in dedicated guides rather than cluttering the front landing.
Step 3 — Propose Plan & Obtain User Approval
[!IMPORTANT] Git Protection Rule (
AGENTS.md):README*.md,docs/, andwebsite/are git-protected files. DO NOT modify these files without explicit user confirmation.
- Present the list of missing features to showcase.
- Show the exact proposed sections in
README.mdanddocs/user/index.md.- Await user confirmation before writing changes.
Step 4 — Synchronize Showcase Surfaces
- Main README (
README.md):- Add to "What You Can Do in the First 10 Minutes" or "Platform Features".
- Keep descriptions action-oriented and evidence-based.
- Korean README (
README.ko.md):- Mirror the changes with natural Korean terminology.
- Project Website Landing (
docs/user/index.md&en/index.md):- Add feature highlight cards or links under "가이드 / Features".
- VitePress Sidebar (
website/.vitepress/config.ts):- Ensure corresponding guides are registered in
koSidebarandenSidebar.
- Ensure corresponding guides are registered in
Step 5 — Validate & Format
Run lightweight formatting and website build validation:
# Verify formatting
pnpm prettier --check "README.md" "README.ko.md" "docs/user/index.md" "website/.vitepress/config.ts"
# Verify VitePress builds cleanly without broken links
pnpm docs:build
(Note: Never run full repository heavy pipelines like pnpm refactor:validate unless explicitly requested by the user.)
📋 Guidelines
- Concise & Scannable (KISS): The front door must not become an unreadable wall of text. Focus on what the user can do with the feature.
- Language Parity: Whenever
README.mdis updated, ensureREADME.ko.mdis synchronized. - Link Accuracy: Every showcase feature must link directly to its deep guide in
docs/user/guides/.