sync-readme
Skill1 starsChanged 9 months agoApache-2.0View on GitHub
Synchronize technical sections in README.md and CONTRIBUTING.md with the actual project state.
3 other projects use a version of this.
Adopted by
Most recently taken up by
- eyeix/skillstheir own version, first seen Oct 13, 2026
- e-dul/opencl-labtheir own version, first seen Mar 23, 2026
- lbb00/ai-rules-synctheir own version, first seen Feb 6, 2026
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 3
- lbb00/ai-rules-sync★ 37same name
- eyeix/skills★ 1same name
- e-dul/opencl-lab★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository16 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- .cursor/rules/tech-stack.mdcCursor rule
- build-and-fixSkill
- bumpup-versionsSkill
- clean-projectSkill
- fix-issueSkill
- improve-claude-configSkill
- initialize-projectSkill
- lint-and-fixSkill
- manage-adrSkill
- manage-changelogSkill
- node-upgradeSkill
- security-vulnerability-auditSkill
- setup-dev-envSkill
- test-and-fixSkill
- test-integration-dockerSkill
The file
We split this skill into the rules it gives an agent
9 rules. About 0 are common, 6 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
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
- Distinctive: line 9
Use this skill to keep the technical documentation (README.md and CONTRIBUTING.md) up-to-date with the codebase.
- Distinctive: line 13
After adding or renaming packages in the monorepo.
- Very specific: line 14
After adding or modifying root scripts in package.json.
- Distinctive: line 15
After adding or changing CLI commands or subcommands.
- Distinctive: line 16
After significant architectural changes or package relationship updates.
- Very specific: line 23
Scripts: Read the root package.json to see available scripts.
- Very specific: line 24
Commands: Read CLI command definitions in packages/cli/src/commands/ to identify commands and subcommands.
- Distinctive: line 34
Update the content between the markers based on your observations:
- Distinctive: line 41
Ensure that you keep the markers themselves and only update the content between them.
≈ “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
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
- Analyze Project State:
Directly observe the project to gather the necessary information:
- Layout: List directories in
packages/andpackages/plugins/to see the monorepo structure. - Scripts: Read the root
package.jsonto see available scripts. - Commands: Read CLI command definitions in
packages/cli/src/commands/to identify commands and subcommands.
- Layout: List directories in
- 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:
- Layout ->
SYNC:LAYOUT(usually inCONTRIBUTING.md): List packages and their descriptions from their respectivepackage.jsonfiles. - Scripts ->
SYNC:SCRIPTS(usually inCONTRIBUTING.md): Format scripts from the rootpackage.jsonas a bulleted list. - Commands ->
SYNC:COMMANDS(usually inREADME.md): Format CLI commands as markdown headings with bash examples. - Architecture ->
SYNC:ARCHITECTURE(usually inCONTRIBUTING.md): Review and update the Mermaid diagram if package relationships or key components have changed.
- Layout ->
- 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 for detailed mapping between metadata and doc sections.
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.