mcpField
U
update-skills-docs

update-skills-docs

github.com/editframeDevelopment1971 installsUpdated 2w ago
Repository

About update-skills-docs

update-skills-docs is a repository workflow for checking code changes against skill documentation and syncing updates. It guides contributors through identifying relevant commits, revising affected docs, and advancing the synchronization tag.

Key features

  1. 01Find skill-sync point
  2. 02Filter documentation-relevant changes
  3. 03Compare code diffs with skill docs
  4. 04Update documentation with focused edits
  5. 05Advance sync tag and publish

Use cases

  1. 01Check whether skill docs are current
  2. 02Find API changes that need documentation
  3. 03Sync revised skill docs to agent directories

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/editframe/skills --skill update-skills-docs

After installing, type/update-skills-docsin Claude Code to confirm it loaded.

Details

From the project README

Update Skills Docs

On load: immediately run the analysis below. No preamble.

Step 1: Find the sync point

git rev-parse skills-sync

If the tag does not exist, create it at the last commit that touched skills/skills/:

BOOTSTRAP=$(git log --oneline -- skills/skills/ | head -1 | awk '{print $1}')
git tag -a skills-sync $BOOTSTRAP -m "skills synced $(date -I)"
git push skills skills-sync

Step 2: Check if already synced

git log skills-sync..HEAD --oneline

If this produces no output, the tag is already at HEAD. Report "Skills docs are up to date." and stop — do not proceed.

Step 3: Get doc-relevant commits

git log skills-sync..HEAD --name-only --oneline

Filter the changed files to doc-relevant paths only. Ignore all others.

Doc-relevant path prefixes
Path prefixSkill
elements/packages/api/src/resources/editframe-api
elements/packages/cli/src/commands/editframe-cli
elements/packages/vite-plugin/src/index.tsvite-plugin
elements/packages/elements/src/elements/composition
elements/packages/elements/src/gui/editor-gui
elements/packages/react/src/gui/editor-gui
elements/packages/react/src/hooks/composition
Exclusion patterns (skip these files entirely)
  • *.browsertest.ts, *.test.ts
  • Any path under src/preview/, src/transcoding/, src/canvas/, src/profiling/
  • Commit subjects matching ^Bump version
  • Lock files, snapshot files, formatter-only commits (subject starts with style: or format:)

Step 4: Read the diffs

For each matched file in a relevant commit:

git show <hash> -- <file>

Look specifically for:

  • New @property or @attribute decorators added to elements
  • Removed properties/attributes
  • Changed default values
  • New exported functions, hooks, or types
  • Changed function signatures or event detail shapes
  • New or removed API endpoint paths in the vite plugin
  • New fields on API payload types (z.object(...) in resources files)

Step 5: Read the corresponding skill doc

Match the changed file to a skill using the table above, then find the relevant reference file in skills/skills/<skill>/references/. Read it with the Read tool.

Step 6: Identify discrepancies

For each matched commit + skill doc pair, identify:

  1. Facts in the doc that are now wrong (stale endpoint paths, removed attributes, changed event shapes)
  2. New API surface not documented (new attributes, new fields, new hooks)
  3. Behavior changes that contradict existing doc prose

Present a numbered list of specific changes before implementing if there are more than 3 items. For 1-3 items, implement immediately.

Step 7: Implement updates

Edit the skill doc files directly. Keep changes minimal and factual — update the specific attribute, endpoint, type, or behavior description. Do not restructure docs.

Step 8: Advance the tag

After all updates are complete:

git tag -f -a skills-sync HEAD -m "skills synced $(date -I)"
git push skills skills-sync

Then sync internal skills to agent directories and push skills docs:

npm run skills:sync
./scripts/push-skills

Then commit:

git add .skills/ skills/skills/ .claude/skills/ .cursor/skills/ .opencode/skills/
git commit -m "sync skills docs to HEAD"

Bootstrap note

The skills-sync tag lives in the monorepo and is pushed to the skills remote. The monorepo has no origin remote — use git push skills skills-sync not git push origin skills-sync.

Comments

Markdown supported