docs(space): 空间配置改版设计与 P1 实现计划 --story=132989396#782
Conversation
新增空间配置改版设计文档(可配置/可解释/可验证/可扩展)与 P1 分步实现计划: 后端声明式元数据框架 + 验证接口骨架 + 前端双栏配置中心 + 通用控件, 复杂配置项本期 JSON 兜底不回退,凭证联动与 API 插件实时预览在 P2/P3 单独成文。 Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
审查总结
本 PR 为纯文档变更,新增空间配置改版的设计文档和 P1 实现计划,文档放置和命名均符合 docs-management.mdc 规范。
整体评价: 设计文档结构清晰,方案论证充分(选型对比、向后兼容、分期规划),实现计划遵循 TDD 流程,与设计文档交叉引用正确。以下为几点小建议,供实现时参考:
✨ 改进建议(Minor)
-
Vue watch 写法(计划 Task 6 ConfigDetail.vue):
watch: { config: { handler(val) {...} } }未配置deep或immediate,按项目 Vue 规范应简写为函数形式config(val) { ... }。 -
verify view 异常捕获(计划 Task 3):
get_config处使用except Exception过于宽泛,建议捕获具体异常(如KeyError),避免掩盖非预期错误。 -
运行命令中的本地路径:计划中
Run:均使用绝对路径/Users/dengyh/...,AI agent 实现时需自行替换为工作目录相对路径,建议在计划顶部统一声明为变量或使用cd <worktree-root>占位。
无 Critical 或 Important 级别问题。文档质量良好,可合入。
面向视觉设计师的交付稿,基于已确认的设计文档与 P1 计划产出: - screens/*.md:5 屏 wiremd 低保真线框源(可 diff / 可导 Figma) - html/*.html:渲染后的自包含 HTML,右侧带编号交互标注 - shots/*.png:全页截图 - README.md:概览 + 3 张 Mermaid 流程图(导航流 / 验证状态机 / 引用型控件联动)+ 每屏编号交互说明表
There was a problem hiding this comment.
增量审查总结
本次推送新增 prototypes/output/space-config-redesign/ 目录,包含 wiremd 低保真线框源文件、渲染 HTML 和截图,用于交付给视觉设计师。
整体评价: 纯原型/设计物料新增,无源代码变更,无安全或性能风险。原型结构清晰(README + screens + html + shots),交互标注与设计文档 docs/specs/2026-07-06-space-config-redesign-design.md 对应良好。prototypes/output/ 目录在仓库中已有先例(123dd66),放置合理。
前次审查建议状态
前次审查的 3 条 Minor 建议(Vue watch 简写、except Exception 范围、计划中本地路径)均针对 docs/plans/2026-07-06-space-config-redesign.md,该文件在本次推送中未修改,建议在实现阶段落实时处理。
本次新增内容
无 Critical 或 Important 级别问题。原型交付物料质量良好,可合入。
- README 去掉面向读者身份的交付/说明性文案,聚焦原型内容本身 - 移除 html/(与 shots 截图同内容),需要交互查看时按 README 命令用 screens/*.md 现渲染
There was a problem hiding this comment.
增量审查总结
本次推送(57e58d8)精简了原型 README 说明文案,并移除了 5 个生成的 HTML 文件(~4159 行),保留 wiremd 源文件和截图作为单一事实来源。
整体评价: 纯文档/原型物料清理,变更方向合理——生成产物不入库、需要时从 screens/*.md 现渲染,减少仓库膨胀和 diff 噪音。无源代码变更,无 Critical / Important 级别问题。
✅ 改进确认
- 移除生成 HTML 是好的实践,README 中已保留渲染命令供需要时使用
- 截图总计 ~1MB,体积可控
- 文案精简后信息密度更高,去掉了面向"交付设计师"的冗余说明
无新增问题需要报告。
There was a problem hiding this comment.
增量审查总结
本次推送(f2e2299)新增 prototypes/output/space-config-redesign/designs/ 目录下 5 张蓝鲸风格简易设计稿 PNG(含红色交互标注),并在原型 README 目录表中补充了 designs/*.png 行。
整体评价: 纯设计物料新增,无源代码变更,无 Critical / Important 级别问题。
✨ 改进建议(Minor)
- 设计稿文件体积偏大:每张 PNG 约 1.3 MB(5 张共 ~6.5 MB),相比
shots/目录的低保真截图(~200 KB/张)大了约 6 倍。由于项目未启用 Git LFS,这些二进制文件会永久膨胀仓库体积。建议在合入前考虑:- 用
pngquant/oxipng等工具做无感知压缩(通常可减 40-60%),或 - 若后续还会频繁迭代设计稿,考虑对
prototypes/**/*.png配置 Git LFS
- 用
以上仅为建议,不阻塞合入。
基于 wiremd 低保真原型产出 5 屏高保真简易设计稿(含红色交互标注), 顶栏用户与空间选择器使用 admin / 演示空间 (100) 占位,避免内部名称泄露。 Co-authored-by: Cursor <cursoragent@cursor.com>
d2bd6d7 to
6f3b9be
Compare
There was a problem hiding this comment.
增量审查总结
本次推送(6f3b9be)将设计稿新增与脱敏合并为一个提交,最终内容为 prototypes/output/space-config-redesign/designs/ 下 5 张蓝鲸风格设计稿 PNG 及 README 目录表补行。
整体评价: 纯设计物料变更,无源代码改动,无 Critical / Important 级别问题。
前次审查建议状态
| 建议 | 状态 |
|---|---|
| Vue watch 简写(Task 6 ConfigDetail.vue) | 待实现阶段落实 |
except Exception 范围过宽(Task 3 verify view) |
待实现阶段落实 |
| 计划中本地绝对路径 | 待实现阶段落实 |
| 设计稿 PNG 体积偏大(~1.3 MB/张) | 未处理,建议合入前用 pngquant/oxipng 压缩或配置 LFS |
本次变更
- ✅ 脱敏处理已合并入设计稿提交,设计稿中不再暴露内部信息
- ✨ README 目录表新增
designs/*.png行,索引完整
无新增问题需要报告。
新增 docs/plans/2026-07-10-space-config-redesign-p2-p3.md:在 P1 元数据框架 基础上,覆盖 credential_map / api_plugin_config(含 uniform_api 实时预览验证)/ plugin_scope / engine_kv 复合控件、结构化↔JSON 源码切换与 canvas_mode 图示补图, 按 TDD 分步给出可执行代码;P1 plan 后续计划段落回链本文件。 Co-authored-by: Cursor <cursoragent@cursor.com>
There was a problem hiding this comment.
增量审查总结
本次推送(a72af44d)新增 docs/plans/2026-07-10-space-config-redesign-p2-p3.md(P2/P3 实现计划,1484 行),并在 P1 计划中补充了交叉引用。
整体评价: 纯文档变更,无源代码改动,无 Critical / Important 级别问题。P2/P3 计划结构与 P1 一致(TDD 流程、前后端分步),与设计文档 §5–§9 的覆盖对应关系清晰(Self-Review 已自查)。技术实现细节验证通过——UniformAPIClient、UniformAPIConfigHandler、Credential、ApiModel.get() 等引用的类名与路径均与现有代码一致。
前次审查建议状态
| 建议 | 状态 |
|---|---|
| Vue watch 简写 | P2/P3 中新增的 watch: { value: { handler, immediate: true } } 因使用了 immediate 属于合理用法,无需改动 |
except Exception 范围 |
P2 Task 1 的 verify 实现中对 UniformAPIClient 调用结果用 request_result.result 判断而非异常捕获,设计合理 |
本地路径 /Users/dengyh/... |
同 P1,仍在 Run: 命令中使用,建议实现时替换(已在前次审查标记,不重复报告) |
✨ 改进建议(Minor)
api_categories可选但ApiModel定义为必填:P2/P3 计划 Task 5 的ApiPluginConfig.vue中api_categories标注为"可选",但现有ApiModel中api_categories: str是必填字段(非 Optional)。实现时verify()对缺少api_categories的配置可能因 pydantic 校验失败而报错——建议实现阶段确认是否需将ApiModel.api_categories改为Optional[str]。
无新增 Critical / Important 级别问题。文档质量良好,可合入。
新增空间配置改版设计文档(可配置/可解释/可验证/可扩展)与 P1 分步实现计划:
后端声明式元数据框架 + 验证接口骨架 + 前端双栏配置中心 + 通用控件,
复杂配置项本期 JSON 兜底不回退,凭证联动与 API 插件实时预览在 P2/P3 单独成文。