mcpField
U
update-skills-docs

update-skills-docs

github.com/editframe开发1971 次安装2 周前更新
代码仓库

关于 update-skills-docs

update-skills-docs 是一套将代码变更与技能文档对照并同步更新的仓库工作流。它引导贡献者筛选相关提交、修改受影响的文档并推进同步标签。

主要功能

  1. 01查找技能同步节点
  2. 02筛选文档相关变更
  3. 03对照代码差异与技能文档
  4. 04定点更新文档
  5. 05推进同步标签并发布

适用场景

  1. 01检查技能文档是否已更新
  2. 02查找需要写入文档的 API 变更
  3. 03将更新后的技能文档同步到 Agent 目录

安装

复制下面的命令，在终端中运行。

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

安装后在 Claude Code 中输入/update-skills-docs确认已加载。

详细介绍

更新 Skills 文档

加载时：立即运行以下分析。不要添加开场白。

第 1 步：查找同步点

git rev-parse skills-sync

如果标签不存在，则在最后一次修改 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

第 2 步：检查是否已同步

git log skills-sync..HEAD --oneline

如果没有输出，则标签已指向 HEAD。报告“Skills 文档已是最新。”并停止——不要继续。

第 3 步：获取与文档相关的提交

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

仅筛选与文档相关路径中的变更文件。忽略所有其他文件。

与文档相关的路径前缀
路径前缀Skill
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
排除模式（完全跳过这些文件）
  • *.browsertest.ts、*.test.ts
  • src/preview/、src/transcoding/、src/canvas/、src/profiling/ 下的任何路径
  • 提交说明匹配 ^Bump version
  • 锁定文件、快照文件，以及仅涉及格式化的提交（说明以 style: 或 format: 开头）

第 4 步：阅读差异

对于相关提交中匹配的每个文件：

git show <hash> -- <file>

重点检查：

  • 元素中新增的 @property 或 @attribute 装饰器
  • 已移除的属性/特性
  • 已更改的默认值
  • 新导出的函数、钩子或类型
  • 已更改的函数签名或事件详情结构
  • vite 插件中新增或移除的 API 端点路径
  • API 负载类型中的新增字段（资源文件中的 z.object(...)）

第 5 步：阅读对应的 skill 文档

使用上表将变更文件与 skill 对应起来，然后在 skills/skills/<skill>/references/ 中找到相关参考文件。使用 Read 工具阅读该文件。

第 6 步：找出差异

对于每组匹配的提交和 skill 文档，找出：

  1. 文档中现已过时的内容（过时的端点路径、已移除的特性、已更改的事件结构）
  2. 文档未涵盖的新 API 表面（新增特性、新字段、新钩子）
  3. 与现有文档描述相矛盾的行为变更

如果超过 3 项，先以编号列表列出具体变更，再进行修改。若为 1–3 项，则立即修改。

第 7 步：实施更新

直接编辑 skill 文档文件。保持修改简洁且基于事实——仅更新具体的特性、端点、类型或行为描述。不要重构文档。

第 8 步：更新标签

所有更新完成后：

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

然后将内部 skills 同步到 Agent 目录，并推送 skills 文档：

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

然后提交：

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

引导说明

skills-sync 标签位于 monorepo 中，并推送到 skills 远程仓库。monorepo 没有 origin 远程仓库——使用 git push skills skills-sync，不要使用 git push origin skills-sync。

评论

支持 Markdown