Skip to content
This repository was archived by the owner on Nov 4, 2026. It is now read-only.

Repository navigation
This repository was archived by the owner on Nov 4, 2026. It is now read-only.

content/docs/utilities/runner.mdx 三处结构性陈述与实现不符:src/schemas 目录、「内置示例 schema」、Package Information 的版本与发布状态 #3577

Closed
#3616
Closed
content/docs/utilities/runner.mdx 三处结构性陈述与实现不符:src/schemas 目录、「内置示例 schema」、Package Information 的版本与发布状态#3577
#3616
Assignees
yinlianghui
Labels
bugSomething isn't workingdocumentationImprovements or additions to documentationpm:dispatched

Description

@yinlianghui
yinlianghui
opened on Aug 7, 2026

越界发现,记录于 #3537(给同一页补 api 查询参数文档)期间。未在该 PR 中顺手修改 —— 该 PR 只在 ## Configuration 下新增一节,不改这三处;它们是独立的陈述面,合并进去会让那个 PR 变成「顺手大扫除」。与 #3533 同源。

事实(均对 origin/main 复核)

1. ## Directory Structure 画的目录不存在。 文档给出

packages/runner/
├── src/
│   ├── App.tsx
│   ├── main.tsx
│   ├── schemas/             # dashboard.json / kanban.json / charts.json
│   └── components/
├── public/

实测 packages/runner/src 下只有:App.tsx、LayoutRenderer.tsx、main.tsx、index.css、lib/MetadataLoader.ts、lib/mockDataSource.ts、__tests__/、plugin-integration.test.ts。没有 schemas/、没有 components/,包根也没有 public/。真实的元数据来源是 src/app-data/(gitignore,新检出为空,见 PR #3537 新增的 "Metadata Loading" 一节)。

2. ## What's Included → ### Example Schemas 说包里带了示例 schema。 文档列了 Dashboard / 数据表格 / 表单校验 / Kanban / 图表 / 日历 / 时间线七类「Runner 包含的示例 schema」。实际这个包一个 schema 文件都不带 —— 承载它们的 src/app-data/ 在 packages/runner/.gitignore:1 里,仓库中不存在;缺该目录时 LocalBundleLoader 的三个 import.meta.glob 编译为 {}(实测:vite dev server 返回的转译结果里 appGlob/pagesGlob/rootGlob 均为 Object.assign({})),/ 渲染的是内置兜底文案 No index page found.。

3. ## Package Information 的版本与发布状态都过期。 文档写

**Version:** 0.3.1
**Type:** Application (not published to npm)

packages/runner/package.json 实测:"version": "17.3.0"、"private": false、"publishConfig": { "access": "public" },且 .changeset/config.json 的 fixed 组里含 @object-ui/runner(随 39 包一起发)。README 底部也挂着 npm 包链接。手写版本号本就会持续漂移,建议直接删掉 Version 行而不是改成 17.3.0。

备注

第 2 条与 #3537 的 PR 有轻微张力:该 PR 新增的一节如实说明「src/app-data/ 由你自己提供,缺失时什么都加载不到」,而本页上方仍写着「Runner 包含这些示例 schema」。两处并存时以新增节为准,本单收尾。

Generated by Claude Code

Activity

  1. claude
    added
    pm:queue
    on Aug 7, 2026

  2. claude commented on Aug 7, 2026

    @claude
    claudeBot
    on Aug 7, 2026 – with Claude
    Contributor

    Triage: pm:queue. No domain:* — whole-repo seat; repo-local docs page, no packages/spec surface ⇒ no transfer.

    Premise re-verified against origin/main after #3537's PR (#3581) landed — all three claims survive the merge that touched this very page:

    content/docs/utilities/runner.mdx:59   ### Example Schemas
content/docs/utilities/runner.mdx:85   │   ├── schemas/             # Example schemas
content/docs/utilities/runner.mdx:221  // src/schemas/test.json
content/docs/utilities/runner.mdx:233  # Edit schemas in src/schemas/
content/docs/utilities/runner.mdx:264  ## Example Schemas
content/docs/utilities/runner.mdx:385  **Version:** 0.3.1
content/docs/utilities/runner.mdx:386  **Type:** Application (not published to npm)
content/docs/utilities/runner.mdx:444  Add to `src/schemas/`:

    Note the surface is wider than the body's three anchors: src/schemas/ recurs at :221, :233, :444, :447, :466 as well. Whoever takes this should sweep the page for the ghost directory rather than fixing only ## Directory Structure, or the page stays self-contradictory.

    Blocking collision is gone: #3537 is closed and its PR #3581 merged, so the page is free. The tension the body records — the new "Metadata Loading" section says src/app-data/ is user-supplied while the page above still advertises bundled example schemas — is now live on main and is precisely what this card resolves; the new section is authoritative.

    Dedupe (three repos, issues + PRs): no duplicate. #3576 (queued this same round) is the sibling card on packages/runner/README.md — different file, no overlap, but the two describe the same package and may sensibly be dispatched together by the lane. #3533 is the same-root "documentation describes things that do not exist" family; #3538 already removed the runner's non-existent env-var surface. On the **Version:** 0.3.1 line the reporter's advice to delete rather than update is the right call — a hand-copied version behind a fixed changeset group (@object-ui/runner ships with 39 packages) drifts again on the next release.

    本评论来自分诊座位 Routine（#5474 试点），不构成认领。

    Generated by Claude Code

  3. yinlianghui
    added
    bugSomething isn't working
    documentationImprovements or additions to documentation
    pm:dispatched
    and removed
    pm:queue
    on Aug 7, 2026
  4. yinlianghui
    self-assigned this
    on Aug 7, 2026

  5. yinlianghui commented on Aug 7, 2026

    @yinlianghui
    yinlianghui
    on Aug 7, 2026 – with Claude
    ContributorAuthor

    认领(PM 分诊晋级)— 会话 session_01GTRjn8xBqp75dk7kFupVRt,分支 claude/issue-3577-runner-mdx-fictions。

    按正文修 content/docs/utilities/runner.mdx 的结构性虚构:src/schemas + src/components + public/ 目录断言(实测均不存在)、"includes example schemas"(不带任何)、Package Information 的版本/发布状态过期(0.3.1/未发布 vs 实际 17.3.0/public)。方向照 #3534/#3539 先例:目录树类断言删手抄指真源,版本类信息要么删要么改为不随版本漂移的措辞(版本号写死必然再过期 —— 优先指向 npm 页)。⚠️ 本文件今天已被 #3538/#3581/#3594 改过三轮,从最新 origin/main 切,逐段读通全文;#3604(Development Workflow 的 JSON-only 矛盾)不在本单,若顺路撞见勿修。

    文件面:content/docs/utilities/runner.mdx。越界即停。

    Generated by Claude Code

  6. yinlianghui commented on Aug 7, 2026

    @yinlianghui
    yinlianghui
    on Aug 7, 2026 – with Claude
    ContributorAuthor

    验收 ACCEPT → PR #3616(session_01GTRjn8xBqp75dk7kFupVRt)。

    已核:CI 绿(Link Check / Control Byte / label 全过);前提三点在新 main(622c8)复核仍成立;9 处(非派单预设的 3 处)全页清扫,行号漂移(+4,#3594 落地)逐一重定位而非盲信,对。

    裁决记录:

    1. 435 行 // src/components/MyComponent.tsx 作为正当幸存者接受:那是教读者自建的文件,且前句已加免责声明,与注册片段的相对 import 保持对齐。
    2. 目录树删除换指路(src/app-data/ + 页内 Metadata Loading 节)符合 console.md 的 Folder Structure 代码块整体过期:列出的 8 个文件/目录有 7 个已不存在 #3534/docs(guide): 删掉 console.md 已整体过期的 Folder Structure 目录树 #3539 先例;npm 断言以 registry API 独立核实(HTML 403 是代理伪象)而非抄文档,是正确的证据方向。
    3. 新发现三单入池:content/docs/utilities/runner.mdx: Best Practices 的「Environment Configuration」小节复活了 #3538 刚删掉的环境变量面,且与同页「reads no environment variables」直接矛盾 #3617(Best Practices 环境变量残留,docs: 删除 runner 不存在的环境变量配置面,修正前端示例的 process.env 读法 #3538 漏网)、content/docs/utilities/runner.mdx §Add Custom Routes 教读者用 react-router-dom 改写 App.tsx,但 runner 不依赖它,路由是手写的 history.pushState #3618(Add Custom Routes 教 react-router-dom 但根本不是依赖)、content/docs/utilities/runner.mdx Features 写「All official plugins included」,实际只预装 kanban + charts 两个,与同页下方清单打架 #3619(「All official plugins included」与同页清单自相矛盾)。⚠️ content/docs/utilities/runner.mdx: Best Practices 的「Environment Configuration」小节复活了 #3538 刚删掉的环境变量面,且与同页「reads no environment variables」直接矛盾 #3617/content/docs/utilities/runner.mdx §Add Custom Routes 教读者用 react-router-dom 改写 App.tsx,但 runner 不依赖它,路由是手写的 history.pushState #3618 均在 runner.mdx,串行等 3616 落 main,且两者互相同文件,只能逐个派。

    Generated by Claude Code

  7. yinlianghui
    closed this as completedin #3616on Aug 7, 2026
  8. akarma-synetal
    added a commit that references this issue on Aug 10, 2026

    docs(runner): 删掉 runner.mdx 的幽灵目录与「内置示例 schema」断言,重写 Package Informat…

    616353a
  9. akarma-synetal
    added a commit that references this issue on Aug 17, 2026

    docs: repair and pin QUICK_REFERENCE's Current Release block, drop th…

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

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