SuperAPI AI 工具集

add-announcement

前端与建站

查看项目

更新于 10-15 16:42

技能介绍

用途:该技能用于向 Agenta 侧边栏横幅系统添加公告卡片。公告卡片显示在侧边栏底部,用户可关闭;系统采用优先级队列,每次只显示一个横幅,关闭后自动显示下一高优先级横幅,并使用 localStorage 记住已关闭的横幅,状态由 Jotai atoms 管理。

主要能力:分为两类公告。一是简单的变更日志公告,只需在 web/oss/src/components/SidebarBanners/data/changelog.json 中添加条目,字段包括 id、title、description、link;id 约定为 changelog- + 日期(YYYY-MM-DD) + 功能 slug,需唯一;标题建议 40 字符以内,描述一句话、100 字符以内;链接指向 https://agenta.ai/docs/changelog/[feature-slug]。二是自定义横幅,用于复杂 UI、交互或逻辑(如试用警告、升级提示),需要修改 types.ts、state/atoms.ts,并在 activeBannersAtom(OSS)或 eeBannersAtom(EE)中创建,适用于不可关闭横幅、自定义 onClick、动态内容或条件显示。

使用方式:先执行 cat web/oss/src/components/SidebarBanners/data/changelog.json 查看现有条目结构,再编辑该文件添加新条目,确保 JSON 合法、id 唯一、链接与将创建的文档页一致。本地测试时清空 localStorage:localStorage.removeItem('agenta:dismissed-banners'),刷新页面即可在侧边栏底部看到横幅。横幅优先级:0 为 star-repo,1 为 changelog,2 为 upgrade,3 为 trial。

适用场景与限制:适用于已部署且已有文档的功能公告;描述会被渲染为纯文本,不能添加自定义 HTML 或样式;需要同时创建 docs/docs/changelog/[feature-slug].mdx 文档页并在 OSS 与 EE 环境中测试。该技能聚焦简单变更日志公告,复杂逻辑的自定义横幅需参考 SidebarBanners README。