docs(frontend): add interactive architecture map - #931
Open
huyanxius wants to merge 3 commits into
Open
Conversation
Frontend orchestration and delivery boundaries were only scattered across code and module notes. Add a validated JSON source, deterministic renderer, and standalone interactive viewer with focused views and source anchors. Preserve the shared workflow core, browser finalization loop, and separate publication adapters as explicit handoff facts.
The architecture artifact needs a stable reading guide and regeneration contract. Document each focused view, the truthful publication split, renderer commands, and validation behavior. Keep the map maintainable without turning it into a stale component inventory or backend topology.
Frontend contributors need a discoverable path to the final architecture handoff. Link the interactive map and its maintenance guide from the frontend README. Make the as-built diagram reachable without changing product code or runtime behavior.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #931 +/- ##
==========================================
+ Coverage 86.12% 91.27% +5.14%
==========================================
Files 306 193 -113
Lines 24037 13204 -10833
Branches 3646 0 -3646
==========================================
- Hits 20703 12052 -8651
+ Misses 2360 1152 -1208
+ Partials 974 0 -974
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
![fennoai[bot]](https://avatars.githubusercontent.com/in/1924301?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
本次完整检查了前端架构图的 README 入口、JSON 源文件、渲染器和生成的独立 HTML。未发现由本 PR 引入且满足可定位、可复现和可修复标准的正确性、可靠性或安全性问题。
已验证：node --check frontend/docs/architecture/render.mjs、npx oxlint docs/architecture/render.mjs、架构节点/连线/视图几何约束、48 个源码锚点在固定 revision 992dadf 中有效，以及独立 HTML 在 Chromium headless 下可加载并初始化。
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
新增一份以实际代码为依据的 Windup 前端架构与创作链路图，让结项交付同时留下可直接阅读、可追溯源码、可重新生成的前端技术地图。
Why
整体架构与内部服务图正在 #926 中补充，但前端拥有的节点编排、任务终态收口和资产交付边界仍散落在代码与模块说明中。历史 #134 保存的是早期设计说明，其中 WorkflowRun、Revision、路由与实现范围已经过期，也无法承担当前结项版本的事实说明。
这份文档需要同时说明三个容易被误解的边界：Quick Start 与 Workflow Editor 共用 Controller 和 WorkflowRun；后端任务终态仍需浏览器完成流程收口；两种入口的动作发布适配目前尚未完全合流。
Changes
Implementation
992dadf，记录 21 个架构节点、21 条关系与 48 个源码锚点；查看器中的源码链接使用该 revision，避免后续行号漂移。CharacterAssetPublisher两条路径，不把共享生成编排描述为尚未实现的端到端统一。Verification
frontend/node_modules/.bin/oxfmt --check frontend/README.md frontend/docs/architecture/README.md frontend/docs/architecture/windup-frontend.architecture.json frontend/docs/architecture/render.mjs frontend/docs/architecture/windup-frontend.html：格式通过。cd frontend && npx oxlint docs/architecture/render.mjs：无 lint 错误。node --check frontend/docs/architecture/render.mjs：语法通过。node frontend/docs/architecture/render.mjs：重复生成后 HTML SHA-256 保持8a6b48f55ba6b71b92727a24809ddb6e9855225feb424afe09c385b7be831385，嵌入数据与源 JSON 一致。jq+git cat-file -e源码锚点审计：48 / 48 有效，0 失败。npm run typecheck、npm run test:coverage、npm run build：Not run（仅新增独立文档与查看器，不修改应用运行代码；按影响面未扩大到产品全量门禁）。Scope
Related Issues
Closes #930
Refs #926
Historical context: #134