Skip to content

[Documentation]: Add an as-built frontend architecture map #930

Description

@huyanxius

Problem

PR #926 正在补充整体架构与内部服务图,但前端拥有的节点编排、任务终态收口和资产交付边界仍散落在代码与模块说明中。尤其是 Quick Start 与 Workflow Editor 共享 Controller、但发布适配尚未完全合流;后端任务完成也不等于浏览器已经闭合 WorkflowRun。

历史 Issue #134 保存的是早期设计说明,已按“设计文档不入库”的约定迁出仓库,其中 WorkflowRun、Revision、路由与实现范围也已过期。项目结项仍缺少一份贴着当前代码、固定 Git revision 的 as-built 前端地图。

Goal

增加一份可直接打开、可追溯源码、可重新生成的前端架构图,准确记录最终交付状态,供项目结项展示和后续维护使用。

Scope

  • frontend/docs/architecture/ 增加人可读架构 JSON、确定性渲染器和独立 HTML 查看器。
  • 展示 App 外壳、Quick Start、Workflow Editor、WorkflowController、WorkflowRun、Generation、SSE 恢复、浏览器出帧、资产发布、Playtest 与导出边界。
  • 提供全景、双入口合流、状态闭环、资产交付四种阅读视图。
  • 支持亮/暗主题、节点源码索引及 SVG / PNG 导出。
  • frontend/README.md 暴露入口。

Acceptance Criteria

  • HTML 可独立打开,不依赖产品服务或外部资源。
  • JSON 经渲染器可确定性生成提交的 HTML。
  • 图中明确区分共享生成编排与仍然分开的发布适配。
  • 图中明确区分后端任务终态与浏览器 WorkflowRun 收口。
  • 全部源码锚点在声明的 Git revision 中有效。
  • 亮色、暗色、桌面与窄屏横向阅读可用,浏览器无控制台错误。
  • 相关文档与生成产物通过格式检查。

Out of Scope

  • 不修改产品代码、接口契约或后端服务拓扑。
  • 不枚举 React 组件目录。
  • 不把当前两条发布路径描述为已经端到端统一。
  • 不恢复或改写早期设计文档。

Refs #926

Historical context: #134

Activity

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions