Skip to content

feat(ui): 治理 Agent 文档并统一交付 Logo Pack - #67

Draft
xiaoland wants to merge 3 commits into
mainfrom
feat/ui-agent-docs
Draft

feat(ui): 治理 Agent 文档并统一交付 Logo Pack#67
xiaoland wants to merge 3 commits into
mainfrom
feat/ui-agent-docs

Conversation

@xiaoland

@xiaoland xiaoland commented Oct 23, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

意图

UI 消费者文档存在已发布内容仍标为“未发布”、选型与依赖说明不符、签名引用类型缺少结构等问题；跨平台 Logo 资产也没有统一的仓库所有者与交付入口。本 PR 纠正文档，接入迁移归档治理，并让 UI 仓库持有和交付 Logo Pack。

  • 纠正四组迁移说明、SettingsForm 的 UnoCSS 要求和 DoubleCheck 的选型描述；补充签名引用的本地类型，区分类型结构与包根导出，移除重复提醒与消费者入口中的维护操作。
  • 在既有 changeset:version 接入迁移归档与失败恢复，在 changeset:publish 接入只读检查；明确作者和审阅者对语义准确性的责任。
  • 原样纳入 2026-10-21 Logo Pack：264 个 SVG／PNG 资产及来源、清单、历史 QA、重建脚本和独立 ZIP。根级 assets/logo/ 是维护源，Web 构建校验并复制，通过 @inkcre/ui-web/logo/* 提供公开静态资源入口。
  • Histoire 与已有 Story 使用统一来源，侧栏按浅深色切换；尺寸选择遵循资产包约定。贡献指南说明后续更新、校验与日期版交付规则。

关联任务：UI Story／docs 的 Agent 使用体验、内容正确性、长期治理及品牌资产交付。

验证

  • 完成 pnpm check 各项检查；修正消费者 fixture 的 Vite 资源类型配置后，重跑格式、lint、根类型、打包消费与 Story 构建通过。
  • 更新受影响文档、生成物、贡献指南及 patch／minor Changeset。
  • 合并前确认最新 main 与远端所需检查。
  • 合并前解决全部审阅讨论。

本地基于 main 34c330d（Web 2.5.0）验证：

  • 8 项版本归档回归使用临时工作区中的真实 Changesets 和元数据生成器，覆盖升版、无变化、无迁移、重复执行、历史保留、非法结构及归档／元数据失败重试。
  • 实际 tarball 独立安装，核对文档类型与真实 API，编译既有 recipes；逐文件验证 Logo 源目录、独立 ZIP 与安装包一致，Vite 消费者实际导入并输出 SVG／高 DPI PNG。
  • Histoire 构建通过：23 个 Story、131 个变体。浏览器核对浅深色侧栏、首页 Logo 和 Header 的 With Logo 变体。
  • Logo 输入 ZIP 的 SHA-256 为 ec4c2390f785d64db23c73f46c3c7a976cb6269d6724e5fa0a807467be79e25f；清单内 SHA-256、文件大小及三份来源的 Git blob SHA 均匹配。
  • git diff --check 仅报告原始 Logo 说明末尾的空行；为保持输入字节与清单一致而保留。排除此原始文件后通过。

未逐个操作全部 Story，未重新渲染 Logo，未执行 registry 发布。历史 QA 报告保留为来源记录。

风险与回退

迁移归档只支持正式版本；标题表示变化归属，不代表 registry 发布成功。自动恢复覆盖 Changesets 成功后的归档或元数据失败；Changesets 自身部分写入时仍需先检查工作树。main 升版后遗留的 migration-base 会在下一次版本准备时同步，当前分支不应跳过版本准备直接发布。

类型说明只追踪同组件目录的定义，不遍历第三方类型图；人工选型与依赖语义仍需结合 Story 或消费者行为审阅。Logo 正常构建不执行重建脚本；显式重建依赖 Inkscape／Pillow，包契约检查依赖现有 macOS／Ubuntu 环境的 unzip。

回退本 PR 可恢复原文档、版本入口和旧 Logo 引用。若已执行版本准备，需同时检查版本、迁移记录和元数据，不覆盖有效 Changeset；若新增 Logo 子路径已正式发布，应先检查消费者引用再移除。

交付影响

  • 没有预览、发布、部署、迁移或凭据影响。
  • 影响与恢复方式已说明。

新增静态资源 exports 和 minor Changeset，既有文档修复保留 patch Changeset。独立日期版 ZIP 可供不使用 Vue 的消费者直接下载；Web 包包含相同文件及 ZIP。没有新增包、workflow 或凭据，未进行生产部署。

普通 PR 允许“下一版本”有内容，发布前必须归档且版本基准一致。公开 tarball 的 registry 交付由独立工作处理；合并并行 package.json 改动时，须同时保留 check:public-package 与 check:release。

依赖关系

父 PR：无。子 PR：无。直接基于 main，不包含其他任务分支提交。

@xiaoland xiaoland added bug Something isn't working documentation Improvements or additions to documentation labels Oct 23, 2026
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 23, 2026 •
edited
Loading

Copy link
Copy Markdown

Deploying inkcre-web-design with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2d8ab17
Status: ✅  Deploy successful!
Preview URL: https://4261564f.design-dd4.pages.dev
Branch Preview URL: https://pr-67.design-dd4.pages.dev

View logs

@xiaoland
fix(web): 修正 Agent 文档并自动归档版本迁移说明
e982981 
- 纠正组件选型和依赖说明，补齐签名类型并移除重复文档
- 接入迁移自动归档、失败恢复和发布前检查
- 扩展实际包消费验证，并覆盖归档与元数据失败重试
@xiaoland
feat(assets): 由 UI 统一持有并交付 Logo Pack
b7fea46 
- 原样保留日期版资产、来源、清单和独立 ZIP
- 接入 Web 静态资源导出并统一 Storyboard 引用
- 验证源目录、压缩包及真实消费者产物一致，明确维护责任
@xiaoland xiaoland changed the title fix(web): 修正 Agent 文档并自动归档版本迁移说明 feat(ui): 治理 Agent 文档并统一交付 Logo Pack Oct 23, 2026
@xiaoland
docs(web): 修正消费者安装指南的认证入口
2d8ab17 
- 指向贡献指南中实际存在的 GitHub Packages 认证章节
- 核对本地及远端目标，并通过 README 格式检查

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@xiaoland