agentleFS
jiahao-shao1jiahao-shao1/sjh-skills/skills/sync-docs/SKILL.md

sync-docs

Skill43 starsChanged 7 months agoMITView on GitHub

Update the project's documentation to match recent code changes, then commit. Triggered when user says "sync docs", "文档同步", or "检查文档".

22 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use prepare-release, review-pr and 1 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • ShopifySkill

    prepare-release

    Prepare the changeset-release/main branch for release by syncing version.ts files and running pnpm install

    Also in 4 projects that use this

  • DockerSkill

    review-pr

    Review one or more incoming Docker documentation pull requests as a maintainer. Independently validate technical claims, assess editorial fit and information architecture, choose a verdict, and draft exact inline or PR-wide feedback behind a confirmation gate. Use for requests such as "review PR 123", "is this PR correct?", "does this information belong here?", "validate this PR", or "help review backlog PRs". Do not use to maintain or fix a PR you own; use maintain-pr for that.

    Also in 3 projects that use this

  • MicrosoftSkill

    release

    Use ONLY when the user explicitly asks to cut/publish a Huabu desktop release or tag a version. Performs an outward action — bumps the version in apps/desktop/package.json, commits + annotated-tags vX.Y.Z, and pushes the branch + tag. That tag push auto-builds the macOS/Windows installers and publishes a GitHub Release. Provides `status`, `bump`, `tag-push`, and a one-command `run` (bump → tag-push).

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 19 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Start from what actually changed (git log, git diff), then read the docs that claim to describe that area.

    line 8

“Common” is measured: kept by at least 6 in 10 of the 19 edited versions of this file we could read. “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

Find where this project's docs have fallen out of sync with its code, bring them back in line, and commit the result.

Start from what actually changed (git log, git diff), then read the docs that claim to describe that area. Every project organizes documentation differently — discover this one's layout instead of assuming a standard set of files.

Judge each gap by what a reader would now get wrong. Sync goes both ways: a doc can be missing something the code now does, or still asserting something it no longer does. Stale text is as much a gap as absent text, so rewrite and delete as readily as you add.

Write the fixes in the voice of the surrounding docs. Stage only the files you edited — never commit -a, since the working tree may hold unrelated code changes — and keep docs in their own commit. Then report what you changed, and separately anything you left alone because the diff didn't say enough to answer it.

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.