agentleFS
Sign inStart free
ric03uecric03uec/clawrium/skills/hermes/docs-sync/SKILL.md

docs-sync

Skill67 starsChanged 2 months agoApache-2.0View on GitHub

Detect user-visible changes from the last 24h of commits on main and propose doc and scenario updates as PRs.

46 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review, handoff 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.
  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 5 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 4 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

5 rules. 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 36 edited versions we read keep these.

  • 2

    Distinctive

    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
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Hard cap: 2 new scenarios per run: Prefer updating an existing scenario over adding a new one.

    line 53
  2. Very specific:

    Do not edit docs/ purely for tone or grammar — out of scope.

    line 59
  3. Very specific:

    Do not touch AGENTS.md, CLAUDE.md, or .itx/ from this skill.

    line 60
  4. Very specific:

    If the diff is unclear, open the PR anyway with [draft] in the title and request input from the author of the originating commit (one short …

    line 61
  5. Distinctive:

    Never merge your own PRs. The PR opens against main and waits for human review.

    line 65

“Common” is measured: kept by at least 6 in 10 of the 36 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

docs-sync

Once per day, find code changes that altered user-visible behavior and propose corresponding updates to docs/ and scenarios/. The goal is that anyone running the documented commands or following the scenarios hits the same surface real users hit today.

Inputs

  • git log --since='24 hours ago' --first-parent main for the commit set (first-parent skips merge-squash internals when present).
  • git diff <prev>..<head> per logical change.
  • The current state of docs/ and scenarios/.

Triage rule — what counts as "user-visible"

Include a change in scope when any of the following is true:

  • Adds, renames, removes, or changes the signature of a clawctl CLI command or option (src/clawrium/cli/).
  • Changes a documented config path or env var.
  • Changes an installation, configuration, or onboarding stage.
  • Changes a GUI route, control, or visible label.
  • Changes output of a clawctl ps-style status command in a way a user would notice.

Exclude pure refactors, test-only changes, dependency bumps that do not change observable behavior, and internal log strings.

Output

For each cluster of related changes, open one PR titled:

docs(<area>): sync with <one-line behavior change>

PR contents:

  • Doc edits limited to the surface that actually changed.
  • Scenario updates limited to scenarios the change actually breaks.
  • Hard cap: 2 new scenarios per run. Prefer updating an existing scenario over adding a new one. If you would exceed the cap, leave a TODO comment in the PR body listing the deferred scenarios.

Hard constraints

  • Do not edit docs/ purely for tone or grammar — out of scope.
  • Do not touch AGENTS.md, CLAUDE.md, or .itx/ from this skill.
  • If the diff is unclear, open the PR anyway with [draft] in the title and request input from the author of the originating commit (one short PR-body line: "@<author> — please confirm the user-facing wording").
  • Never merge your own PRs. The PR opens against main and waits for human review.

Anti-patterns

  • Bulk-updating every doc that mentions a renamed term. Touch only the paths the diff actually changes.
  • Inventing scenarios that the code doesn't exercise. Scenarios must be runnable on a fresh checkout.
  • Producing one mega-PR for a day's worth of changes. One PR per logical doc unit, even if that means three PRs in a single run.

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.

Check your setup, free