readme-showcase-sync
Skill11 starsChanged 19 days agoMITView on GitHub
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 when the user requests to update the main README, sync landing pages, showcase new features on the project page, or "메인 README 누락 업데이트", "프로젝트 페이지 랜딩 업데이트", "쇼케이스 동기화", "신규 기능 README 반영".
In this repository48 other files it gives its agents.
- agents.mdAGENTS.md
- .agents/skills/react-best-practices/AGENTS.mdAGENTS.md
- .agents/skills/react-native-skills/AGENTS.mdAGENTS.md
- .agents/skills/react-view-transitions/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- agent-initSkill
- agy-delegateSkill
- audit-docsSkill
- code-audit-expertSkill
- computer-diagnosisSkill
- create-builtin-toolSkill
- create-prSkill
- critique-builtin-toolSkill
- doc-auditorSkill
- docxSkill
- extract-log-debugSkill
- feature-refactor-proposalSkill
- gatekeeper-loopSkill
- harbor-harness-improvement-loopSkill
- i18n-language-standardsSkill
- jobs-trace-analyzerSkill
- lean-builtin-tool-auditorSkill
- libragent-qualitySkill
- libr-delegateSkill
- libr-tool-e2e-harness-loopSkill
- modular-large-file-refactorSkill
- performance-auditSkill
- pptxSkill
- vercel-react-best-practicesSkill
- vercel-react-native-skillsSkill
- vercel-react-view-transitionsSkill
- refactor-builtin-toolSkill
- release-managerSkill
- review-local-changesSkill
- review-pr-commentsSkill
- science-searchSkill
- setup-wizardSkill
- skill-creatorSkill
- soul-awakeningSkill
- sqlite-analyzerSkill
- sync-pending-approvalsSkill
- tool-creatorSkill
- trace-analyzerSkill
- trace-eval-loopSkill
- vitepress-doc-syncSkill
- worker-loopSkill
- x-cliSkill
The file
We split this skill into the rules it gives an agent
8 rules. About 0 are common, 5 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 14
When new features (e.g., Solution Recipes, Scheduled Tasks, Browser Sidecar, Session Export, Bundled Skills like ig-cli) are implemented, …
- Distinctive: line 28
Run the automated showcase audit script:
- Distinctive: line 62
Add to "What You Can Do in the First 10 Minutes" or "Platform Features".
- Distinctive: line 63
Keep descriptions action-oriented and evidence-based.
- Distinctive: line 67
Add feature highlight cards or links under "가이드 / Features".
- Very specific: line 69
Ensure corresponding guides are registered in koSidebar and enSidebar.
- Distinctive: line 73
Run lightweight formatting and website build validation:
- Very specific: line 91
Link Accuracy: Every showcase feature must link directly to its deep guide in docs/user/guides/.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
README & 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.jsonThe 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/.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

