Skip to content

docs(guide): 删掉 console.md 已整体过期的 Folder Structure 目录树 - #3539

Merged
yinlianghui merged 1 commit into
mainfrom
claude/issue-3534-console-folder-structure
Aug 7, 2026
Merged

docs(guide): 删掉 console.md 已整体过期的 Folder Structure 目录树#3539
yinlianghui merged 1 commit into
mainfrom
claude/issue-3534-console-folder-structure

Conversation

@yinlianghui

Copy link
Copy Markdown
Collaborator

Fixes #3534

背景

content/docs/guide/console.md 的 "Folder Structure" 代码块自称描述 apps/console/,但已整体漂移。PR #3532 只删了其中 MSW 那两行,结构性漂移未动。

复核实测(基于 origin/main a2c8f2a29,已含 #35328c44bb661)

原块共 11 个叶子条目,只有 3 个还对得上:App.tsxdataSource.tshooks/useBranding.ts。其余:

文档里写的 实际位置
components/AppHeader.tsx packages/app-shell/src/layout/AppHeader.tsx
components/AppSidebar.tsx packages/app-shell/src/layout/AppSidebar.tsx
components/CommandPalette.tsx packages/app-shell/src/chrome/CommandPalette.tsx
components/ConsoleLayout.tsx packages/app-shell/src/layout/ConsoleLayout.tsx
components/ObjectView.tsx packages/app-shell/src/views/ObjectView.tsx
components/RecordDetailView.tsx packages/app-shell/src/views/RecordDetailView.tsx
context/ExpressionProvider.tsx packages/app-shell/src/providers/ExpressionProvider.tsx(apps/console/src/context/ 这个目录不存在)
hooks/useObjectActions.ts packages/app-shell/src/hooks/useObjectActions.ts
pages/CreateAppPage.tsx packages/plugin-designer/src/pages/CreateAppPage.tsx
pages/EditAppPage.tsx packages/plugin-designer/src/pages/EditAppPage.tsx

比 issue 记的还多两处:useObjectActions.ts 也迁走了,而 CreateAppPage/EditAppPage 去的是 plugin-designer 而不是 app-shell —— 所以新 prose 没有把「全都在 app-shell」写死。

改法(PM 裁定,与 #3488 先例同构)

不逐项重写目录树:手写的目录树是注定再次漂移的手抄本,逐项重写只是把下一次漂移推迟到下一次重构。整块删掉,换成一段 prose,只保留唯一承重的那条信息 —— console 的绝大多数视图/布局在 packages/app-shell,apps/console 只是装配层

新 prose 的每条断言都有源码依据,不是继承来的:

  • 「任何宿主应用都能挂载同一套体验」← apps/console/src/AppContent.tsx 自己的注释:"The full inner-SPA shell (ConsoleLayout, CommandPalette, ObjectView etc.) lives in @object-ui/app-shell as DefaultAppContent … third-party hosts that don't need those routes use DefaultAppContent directly."
  • 「owns the route tree」← apps/console/src/App.tsx 注释:"Owns the full route tree including unauthenticated auth surfaces…"
  • 「registers the plugin set」← apps/console/src/register-plugins.ts:"Console plugin registration — the SDUI block layer."
  • 「wires the backend connection」← dataSource.ts 转出 ObjectStackAdapter,配合本文上一节的 VITE_SERVER_URL
  • 「console 专属界面(auth / docs portal / system / settings)」← 实测 apps/console/src/pages/{auth,system,settings}/pages/Docs*.tsx

关于链接:没有重复贴 URL

裁定要求指向 /docs/guide/console-architecture。该链接已经是紧随其后的 "See Also" 第一条 —— 新段落是 See Also 之前的最后一节,两行之隔再贴一次同一个 URL 是可见的冗余。因此段落以「先去 packages/app-shell 找」这条可执行结论收尾,深入阅读交给既有的 See Also 条目承接,See Also 一字未动。

验证

  • node scripts/check-doc-links.mjsDocs links are valid.,exit 0
  • pnpm exec vitest run scripts/ --maxWorkers=214 passed (14) / 216 passed (216)。跑前预测「保持绿」:没有任何测试读 console.md 的正文(check-doc-links.test.ts 是在临时目录里造合成仓库,不读真实 guide 文件);实测与预测一致。
  • node scripts/check-control-bytes.mjs → OK(3695 个文本文件),另对本文件单独 grep -naP 自检控制字节,干净。
  • 全文通读:与 docs(guide): 改教真正生效的 VITE_SERVER_URL,删除不存在的 MSW 开关 #3532 刚改过的 Quick Start 不冲突(未触及 mock backend / VITE_SERVER_URL 的说法),与上方 Key Features 表里的 Command Palette 等条目一致。
  • #folder-structure 锚点全仓无引用,删标题不会产生死链。

纯 content 文档改动,按仓库约定不加 changeset;未触碰 content/docs/releases/

🤖 Generated with Claude Code

https://claude.ai/code/session_01GTRjn8xBqp75dk7kFupVRt


Generated by Claude Code

那一块自称描述 apps/console/,但列出的 11 个叶子条目里只有 3 个还对得上
(App.tsx、dataSource.ts、hooks/useBranding.ts)。6 个组件早已迁到
packages/app-shell,useObjectActions.ts 同样,CreateAppPage/EditAppPage 去了
packages/plugin-designer,而 context/ExpressionProvider.tsx 这个路径在
apps/console 下根本不存在。

不逐项重写:手写目录树是注定再次漂移的手抄本(#3488 先例——删手抄,指真源)。
整块删掉,换成一段实测过的 prose,只保留唯一承重的那条信息——console 的绝大
多数视图/布局在 packages/app-shell,apps/console 只是装配层。深入阅读由紧随
其后的 See Also 里既有的 Console Architecture 链接承接,不重复贴同一个 URL。

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GTRjn8xBqp75dk7kFupVRt
@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectui Ignored Ignored Aug 7, 2026 3:21am

Request Review

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

console.md 的 Folder Structure 代码块整体过期:列出的 8 个文件/目录有 7 个已不存在

2 participants