agentleFS
fritzprixfritzprix/libr-agent/.agents/skills/readme-showcase-sync/SKILL.md

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 반영".

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
  1. Very specific:

    When new features (e.g., Solution Recipes, Scheduled Tasks, Browser Sidecar, Session Export, Bundled Skills like ig-cli) are implemented, …

    line 14
  2. Distinctive:

    Run the automated showcase audit script:

    line 28
  3. Distinctive:

    Add to "What You Can Do in the First 10 Minutes" or "Platform Features".

    line 62
  4. Distinctive:

    Keep descriptions action-oriented and evidence-based.

    line 63
  5. Distinctive:

    Add feature highlight cards or links under "가이드 / Features".

    line 67
  6. Very specific:

    Ensure corresponding guides are registered in koSidebar and enSidebar.

    line 69
  7. Distinctive:

    Run lightweight formatting and website build validation:

    line 73
  8. Very specific:

    Link Accuracy: Every showcase feature must link directly to its deep guide in docs/user/guides/.

    line 91

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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:

  1. Detecting features implemented in code but omitted from README.md and docs/user/index.md.
  2. Planning concise, high-impact showcase updates.
  3. 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/, and website/ are git-protected files. DO NOT modify these files without explicit user confirmation.

  1. Present the list of missing features to showcase.
  2. Show the exact proposed sections in README.md and docs/user/index.md.
  3. Await user confirmation before writing changes.

Step 4 — Synchronize Showcase Surfaces

  1. 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.
  2. Korean README (README.ko.md):
    • Mirror the changes with natural Korean terminology.
  3. Project Website Landing (docs/user/index.md & en/index.md):
    • Add feature highlight cards or links under "가이드 / Features".
  4. VitePress Sidebar (website/.vitepress/config.ts):
    • Ensure corresponding guides are registered in koSidebar and enSidebar.

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.md is updated, ensure README.ko.md is synchronized.
  • Link Accuracy: Every showcase feature must link directly to its deep guide in docs/user/guides/.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.