Menu
Synchronize technical sections in README.md and CONTRIBUTING.md with the actual project state.
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
A direct command skips the review prompt. Inspect the source before running it.
npx skills add https://github.com/yu-iskw/coding-agent-fabric --skill sync-readmeThe command stays on one line. Scroll horizontally to inspect it before copying.
Prefer a local copy? Download the files currently available to SkillsMP.
Based on SOC occupation classification
Showing SKILL.md
| name | sync-readme |
| description | Synchronize technical sections in README.md and CONTRIBUTING.md with the actual project state. |
| version | 1.0.0 |
Use this skill to keep the technical documentation (README.md and CONTRIBUTING.md) up-to-date with the codebase.
package.json.Analyze Project State: Directly observe the project to gather the necessary information:
packages/ and packages/plugins/ to see the monorepo structure.package.json to see available scripts.packages/cli/src/commands/ to identify commands and subcommands.Locate Sync Markers: Find the following markers in the documentation files:
<!-- SYNC:LAYOUT --> ... <!-- /SYNC:LAYOUT --><!-- SYNC:SCRIPTS --> ... <!-- /SYNC:SCRIPTS --><!-- SYNC:COMMANDS --> ... <!-- /SYNC:COMMANDS --><!-- SYNC:ARCHITECTURE --> ... <!-- /SYNC:ARCHITECTURE -->Update Content: Update the content between the markers based on your observations:
SYNC:LAYOUT (usually in CONTRIBUTING.md): List packages and their descriptions from their respective package.json files.SYNC:SCRIPTS (usually in CONTRIBUTING.md): Format scripts from the root package.json as a bulleted list.SYNC:COMMANDS (usually in README.md): Format CLI commands as markdown headings with bash examples.SYNC:ARCHITECTURE (usually in CONTRIBUTING.md): Review and update the Mermaid diagram if package relationships or key components have changed.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.