Skip to content

console-architecture.md 教了一套不存在的 MSW Mock Mode,且与 #3532 刚修正的 console.md 直接矛盾 #3540

Description

@yinlianghui

越界发现,记录于 #3534 / PR #3539(删掉 console.md 已整体过期的 Folder Structure 目录树)期间 —— 该 PR 把读者导向 /docs/guide/console-architecture,通读那一页时发现它自身带着同类缺陷。本单不在 #3534 的文件面内,单独记录。

一、MSW Mock Mode 整节描述的能力不存在(与 console.md 直接打架)

content/docs/guide/console-architecture.md 第 134-143 行:

MSW Mock Mode

In development, the console uses MSW (Mock Service Worker) to simulate an ObjectStack backend:

  1. objectstack.config.ts defines apps and objects via @objectstack/spec
  2. @objectstack/runtime boots an ObjectKernel with MSWPlugin
  3. MSW intercepts /api/v1/* requests and serves in-memory data
  4. The ObjectStackAdapter connects to this mock server transparently

This allows full offline development without a real backend.

同一份 guide 里,console.md 第 18 行(PR #3532 刚刚改成的措辞)说的正相反:

There is no bundled mock backend — apps/console/.env.development points VITE_SERVER_URL at http://localhost:3000, so an ObjectStack server has to be listening there.

实测(origin/main a2c8f2a29):

即整节属于「描述不存在的能力」—— 与 #3532console.md 里清掉的死环境变量/死 MSW 开关完全同类,只是漏在了这份姊妹页里。第 17 行数据流图中的 MSW / Real Server 标注同源。

影响:读者按它去配 offline 开发会直接失败;两页给出互相矛盾的指引,而 console.md 的 See Also 正把人往这一页送。

二、同页的组件归属漂移(与 #3534 同根,程度较轻)

第 8 行称本页描述 "the Console app (apps/console)",但其后的数据流图与正文点名的 ExpressionProvider / ConsoleLayout / AppSidebar / AppHeader / ObjectView / RecordDetailView 现均在 packages/app-shell,CreateAppPage / EditAppPagepackages/plugin-designer(逐项实测见 PR #3539 的表格)。

#3534 的区别:这一页大多按角色而非路径描述,所以不像目录树那样条条落空;但第 101 行 "The console's ObjectView is a thin wrapper around @object-ui/plugin-view's ObjectView" 这类句子的主语归属已经不准(该 wrapper 在 app-shell,不在 console)。修一的时候顺带核一下更划算。

建议

第一部分是实打实的错误指引,建议整节删除 + 清掉数据流图里的 MSW / Real Server 标注,与 #3532 的处理保持一致;第二部分建议在同一 PR 里按 role/package 口径校一遍,别再写死路径。

备注

#3527 的席位纪律,查重由 PM 座位统一执行(共享 GitHub 身份有速率限制,dev 席位不重复 search),本单未做 search。若已有同源单请 race-close 本单。未认领,留给 PM 分诊。


Generated by Claude Code

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentationpm:dispatched

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions