Skip to content

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

Description

@yinlianghui

越界发现,记录于 #3527 / PR #3532(把 console.md 里的死环境变量改教 VITE_SERVER_URL)期间。PR #3532 只删了其中 MSW 那两行(mocks/ browser.ts # MSW browser worker —— 因为它是该 PR 必须清掉的「描述不存在的能力」那一类,目录已随 2b7435b76 一起删除),整块的结构性漂移未动:与死环境变量不同类,整块重写要逐项对源码核,值得单独一单。

现状

content/docs/guide/console.md 的 "Folder Structure" 代码块(PR #3532 合并后为 99-121 行)自称描述 apps/console/:

apps/console/
  src/
    App.tsx                    # Root component + routing
    dataSource.ts              # ObjectStackAdapter wrapper
    components/
      AppHeader.tsx            # Top navbar (breadcrumbs, connection status)
      AppSidebar.tsx           # Left sidebar (app switcher, navigation tree)
      CommandPalette.tsx       # ⌘+K command bar
      ConsoleLayout.tsx        # AppShell wrapper
      ObjectView.tsx           # Object list view (wraps plugin-view)
      RecordDetailView.tsx     # Single-record detail view
    pages/
      CreateAppPage.tsx        # App creation wizard page
      EditAppPage.tsx          # Edit existing app page
    context/
      ExpressionProvider.tsx   # Expression evaluation context
    hooks/
      useBranding.ts           # Delegates to @object-ui/layout
      useObjectActions.ts      # CRUD action handlers

实测

apps/console/src/components/ 的真实内容:

FormPage.tsx / FormPage.test.ts
MetadataHmrReloader.tsx
PerformanceDashboard.tsx
RootLandingRedirect.tsx / RootLandingRedirect.test.ts
schema/

即文档列出的 6 个组件(AppHeader / AppSidebar / CommandPalette / ConsoleLayout / ObjectView / RecordDetailView)一个都不在那里 —— 它们早已迁到 packages/app-shell(例如 packages/app-shell/src/layout/AppHeader.tsxpackages/app-shell/src/views/ObjectView.tsxpackages/app-shell/src/views/RecordDetailView.tsx)。

context/ 目录整个不存在(apps/console/src 下没有 context,也没有 ExpressionProvider.tsx)。

只有 App.tsxdataSource.tspages/hooks/ 这几项名字还对得上。反过来,真实的 apps/console/src 里有一大批文档完全没提的东西:AppContent.tsxregister-plugins.tsregisterStudioComponents.tsxregisterDeveloperComponents.tsxregisterAccountComponents.tsxloadLanguage.tsschemas/services/preview-*.tsx 等。

影响

这一块是读者「想改 console 某个部件、先看目录找入口」的第一落点。按它去 apps/console/src/components/AppHeader.tsx 找顶栏,会找不到文件,也拿不到「它其实在 packages/app-shell」这条关键信息 —— 而 app-shell 与 apps/console 的分工正是这份文档最该讲清的事。

建议

要么按当前源码重写这一块(顺带点明「console 的绝大多数视图/布局在 packages/app-shell,apps/console 只是装配层」),要么整块删掉、改为指向 /docs/guide/console-architecture(该页已在同文件的 "See Also" 里)。倾向后者:一份手写的目录树注定会再次漂移,而这一块的真正价值只有「哪些东西在 app-shell、哪些在 apps/console」那一句。

备注

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


Generated by Claude Code

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions