agentleFS
himkthimkt/cafleet/.claude/skills/update-readme/SKILL.md

update-readme

Skill56 starsChanged 4 days agoMITView on GitHub

Reconcile README.md with the documentation site and SPEC.md with the shipped binary and code when those maintained surfaces change.

8 other projects use a version of this.

Adopted by

Most recently taken up by

The file

Files
SKILL.md

Update README and SPEC

Read the documentation-site concepts and navigation, the shipped CLI behavior and code, and the current maintained targets. Apply the task directly when it needs one session; use CAFleet for independent delegated review when the task calls for it. An assigned member performs its own scoped work within the existing team.

README structure

Retain the title/demo/pitch, Install, Documentation and License surfaces. Align the pitch with the site hero, installation with Quickstart and documentation links with navigation; the Specification link points at SPEC.md. Keep detailed CLI/architecture/development content in the documentation site.

SPEC maintenance

SPEC owns every contract and is the self-contained reimplementation specification. Reconcile it with the shipped binary and code: current CLI options/defaults, environment, schema, native input, finite receiving, authored errors, JSON order, text layouts, runtime, multiplexer and backend behavior. Preserve its section numbering (an empty numbered section is removed without renumbering the others) and required detail, update the affected contracts together, remove obsolete concepts completely and keep the description affirmative.

Retain exact current argv, SQL and error blocks, and reference bundled preset files by path. Verify § cross-references against the section headings. Report the focused validation performed and material limitations. Write all maintained artifacts in English.

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.