Index of every page on this site: llms.txt
All skills
waynesutton avatar

/update-project-docs

@853b196
Run it yourself

Brings task.md, changelog.md, and files.md back in sync with what the code says shipped, then prints a commit message as plain text. Reads git history and the working tree, never memory, and refuses to log features it cannot see in source. Use when a feature or fix lands, when the user says /update, @update, update project docs, sync changelog, or update files.md, or when task.md and the code disagree.

Use this Skill: https://skilld.dev/gh/waynesutton/builder-skills/update-project-docs

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencesevidence-rules.md

≈586 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Evidence rules

What counts as proof that something shipped, and how strong each kind is.

Strong evidence

Use these freely.

Source Command Shows
Commit history git log --date=short --pretty='%ad %h %s' -n 20 What landed and when
Changed files per commit git show --stat <sha> Which files a change touched
Staged changes git diff --cached --stat What is about to be committed
Working tree changes git diff --stat and git status --short What changed since the last commit
Version bump git log -p -n 5 -- package.json When a version heading should be dated
Source content reading the file What a feature does

Weak evidence

Use with a hedge in the entry.

Source Why it is weak
File modification times without git Copies and checkouts reset them
Dependency in package.json Installed is not used
A PRD or plan Plans describe intent, not what shipped
The conversation Memory of what was discussed drifts from what was written
Commit message alone Messages lie. Check the stat.

Not evidence

  • Generated files (_generated/, lockfiles, build output). Do not count these as progress.
  • Formatting only commits.
  • Files in node_modules.
  • Anything read from an environment file.

Deriving facts

  • Project name: package.json name, then README title, then folder name.
  • Repository URL: git remote get-url origin, converted to https.
  • Release date: the commit that changed the version in package.json. If uncommitted, today in UTC.
  • Author of a change: not needed in changelog or files.md. Leave it out.

Idempotency check

Before writing, compare:

  • latest commit sha in git vs the last sha or date mentioned in changelog.md
  • git status --short output vs items already In Progress in task.md
  • files in the diff vs files already described in files.md

If all three match, the docs are current. Do not touch them. Report "already current".

When evidence conflicts with a doc

The doc says X shipped. The code does not show X.

  1. Keep the evidence based value.
  2. Fix the doc line.
  3. Tell the user in one line: "changelog said cron cleanup shipped in 1.2.0, no crons.ts exists, removed the line."

Do not silently rewrite. Do not leave the wrong claim in place.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts11d3 checks · Risk SAFE
  • Gen Agent Trust Hub11d

    The skill is a documentation synchronization utility that updates task.md, changelog.md, and files.md based on git history and source code. It includes strong privacy protections, such as explicit redaction rules for secrets and personal identifiers, and restricts itself to local read/write operations without network access or deployment capabilities.

  • Socket11d

    No alerts

  • Snyk11d

    Risk: LOW · No issues

Signed by skilld at 853b196. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 6 days ago.

Activeupdated 2 weeks ago

README badge

README badge for waynesutton/builder-skills/update-project-docs