Skills

Fastgpt Release Docs

仅在用户明确调用本 Skill 时,为 FastGPT 编写或更新指定版本的中英文 MDX 更新说明。支持 v4.17.3、4.17.3 或 4173...

Install

npx skills add labring/FastGPT --skill fastgpt-release-docs -g -a claude-code -y
Repository
labring/FastGPT30k
Category
Engineering
Updated
3d ago
License
See repository
Context cost
Lightabout 1,272 tokens
Runs scripts
No, instructions only

What it does

仅在用户明确调用本 Skill 时,为 FastGPT 编写或更新指定版本的中英文 MDX 更新说明。支持 v4.17.3、4.17.3 或 4173 等版本输入,对比上一正式版本,按功能领域归并改动,先写中文再调用 doc-i18n 翻译英文。不自动用于普通代码任务或一般文档编辑。

FastGPT 版本文档

调用与范围

仅手动调用,例如:

  • $fastgpt-release-docs 4173
  • 使用 fastgpt-release-docs 更新 v4.17.3 文档,对比上一正式版本。
  • $fastgpt-release-docs v4.17.3,目标 ref 使用当前分支。

本 Skill 的产物是版本中文源文、对应英文 MDX,以及必要的同目录导航更新。调用本 Skill 不代表要求修改产品代码、切换分支、创建 worktree、提交、推送或创建 PR;这些动作按本次用户要求执行。

优先使用当前 FastGPT 仓库;当前目录不是该仓库时,使用用户指定的 FastGPT 仓库目录。先阅读仓库适用的 AGENTS.md,检查工作区,保留用户已有修改。不要因文档任务强制清理、重置或切换工作区。

1. 确认版本、文件与比较范围

版本与文件

  • v4.17.3、4.17.3 和 4173 均可表示 V4.17.3。
  • 简称通过已有文档的 basename、frontmatter 和 Git tag 交叉确认,不按固定字符位置硬拆版本号;无法唯一确定时只询问版本歧义。
  • 优先定位已有页面。通常对应 document/content/self-host/upgrading/4-17/4173.mdx 与 4173.en.mdx;新页面沿用同系列目录和命名规则。
  • 阅读目标版本、上一版本中文说明与同目录 meta.json / meta.en.json,保留既有 frontmatter、组件和有依据的人工说明。

比较范围

  1. 用户指定比较基准或目标 ref 时,以其为准。
  2. 未指定基准时,查找低于目标版本的最近一个正式发布 tag,按版本顺序判断,排除预发布 tag;不要直接将补丁号减一。例如存在 v4.17.2 时,V4.17.3 通常以它为基准。
  3. 目标版本已有正式 tag 时,默认比较到该 tag。尚未发布且没有目标 tag 时,默认比较到最新 upstream/main;缺少该 remote 时检查实际发布仓库的 main,不把任意同名分支当成上游。
  4. 按需刷新选定 remote 的 main 与版本 tags,只更新引用,不 checkout 或 rebase。若上一正式版本缺失,先检查远端;仍无法确定时询问比较基准,不自行猜测。
  5. 开始分析前固定两端 commit SHA,并向用户简要说明版本、比较范围和目标文档。当前分支或未提交的产品改动仅在用户要求时纳入,不把无关工作区改动混入版本范围。

使用提交记录发现线索,使用两端最终代码差异确认事实:

git log --oneline <base-sha>..<target-sha>
git diff --stat <base-sha> <target-sha>
git diff <base-sha> <target-sha> -- <related-paths>

不要只依赖 PR 标题、commit message 或已有版本文档。阅读相关实现、配置、迁移、接口合约及必要的局部测试,核实最终用户行为。被撤回、覆盖且不再生效的改动不列为发布内容。

Pro 子模块

主仓库范围包含 Pro 变更时,同时分析两个版本实际引用的子模块提交:

git ls-tree <base-sha> pro
git ls-tree <target-sha> pro
git -C pro diff --stat <pro-base-sha> <pro-target-sha>
git -C pro log --oneline <pro-base-sha>..<pro-target-sha>

继续读取相关 Pro diff,不使用当前 Pro 分支或 Pro 最新 main 替代版本指针。必要时获取对应提交对象,不改子模块 checkout。有权限或对象缺失时,说明未核实范围,不补写推测的商业版能力。区分商业版、开源版与外部服务能力。

2. 从改动中归纳版本主题

先形成“用户变化 → 适用范围 → 边界/升级动作 → 代码证据”的候选清单,通常保留在工作上下文中,不额外生成分析报告。

Read the whole SKILL.md on GitHub

More in Engineering