AgentStack
Sign in Publish
MCP servers Skills Toolkits Why AgentStack Sell Docs
Sign in
SKILL verified Apache-2.0 Self-run

Sync Readme

skill-yu-iskw-coding-agent-fabric-sync-readme · by yu-iskw

Synchronize technical sections in README.md and CONTRIBUTING.md with the actual project state.

↗ Repository
— No reviews yet
0 installs
3 views
0.0% view→install

Install

$ agentstack add skill-yu-iskw-coding-agent-fabric-sync-readme

✓ scanned · ✓ verified — works with Claude Code, Cursor, and more.

Security review

✓ Passed

No issues found. Passed automated security review. · v0.1.0 How review works →

  • ✓ Prompt-injection patterns
  • ✓ Secret / credential exfiltration
  • ✓ Dangerous shell & filesystem operations
  • ✓ Untrusted network calls
  • ✓ Known-malicious package signatures

What it can access

  • ✓ Network access No
  • ✓ Filesystem access No
  • ✓ Shell / process execution No
  • ✓ Environment & secrets No
  • ✓ Dynamic code execution No

From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.

Are you the author of Sync Readme? Claim this listing to set pricing, connect Stripe payouts, and keep 70% of every sale.
Sign up to claim

About

sync-readme

Use this skill to keep the technical documentation (README.md and CONTRIBUTING.md) up-to-date with the codebase.

When to Use

  • After adding or renaming packages in the monorepo.
  • After adding or modifying root scripts in package.json.
  • After adding or changing CLI commands or subcommands.
  • After significant architectural changes or package relationship updates.

Workflow

  1. Analyze Project State:

Directly observe the project to gather the necessary information:

  • Layout: List directories in packages/ and packages/plugins/ to see the monorepo structure.
  • Scripts: Read the root package.json to see available scripts.
  • Commands: Read CLI command definitions in packages/cli/src/commands/ to identify commands and subcommands.
  1. Locate Sync Markers:

Find the following markers in the documentation files:

  • ` ... `
  • ` ... `
  • ` ... `
  • ` ... `
  1. Update Content:

Update the content between the markers based on your observations:

  • Layout -> SYNC:LAYOUT (usually in CONTRIBUTING.md): List packages and their descriptions from their respective package.json files.
  • Scripts -> SYNC:SCRIPTS (usually in CONTRIBUTING.md): Format scripts from the root package.json as a bulleted list.
  • Commands -> SYNC:COMMANDS (usually in README.md): Format CLI commands as markdown headings with bash examples.
  • Architecture -> SYNC:ARCHITECTURE (usually in CONTRIBUTING.md): Review and update the Mermaid diagram if package relationships or key components have changed.
  1. Preserve Formatting:

Ensure that you keep the markers themselves and only update the content between them. Use appropriate markdown blocks (code blocks, lists) that match the existing documentation style.

References

  • See [references/mapping.md](references/mapping.md) for detailed mapping between metadata and doc sections.

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

Install and usage instructions live in the source repository linked above.

Reviews

No reviews yet — be the first.

Write a review

Versions

  • v0.1.0 Imported from the upstream source.

More in Agent Skills