Skip to content

README.md 推荐了 4 个不存在的 example 应用(examples/crm、todo、kitchen-sink、msw-todo) #3480

Description

@yinlianghui

README.md 的 Examples 小节列了 6 个 example,其中 4 个在仓库里不存在。

现状

README.md:59-62:

- **[examples/crm](examples/crm)** - Full-featured CRM application with dashboards, multiple views (Grid, Kanban, Map, Gantt), and custom server implementation.
- **[examples/todo](examples/todo)** - Simple task management app demonstrating basic ObjectStack configuration and field types.
- **[examples/kitchen-sink](examples/kitchen-sink)** - Comprehensive component catalog showing all available field types, dashboard widgets, and view types.
- **[examples/msw-todo](examples/msw-todo)** - Frontend-first development example using MSW (Mock Service Worker) to run ObjectStack in the browser.

examples/ 实际内容:

examples/README.md
examples/byo-backend-console
examples/console-starter
examples/hello-world
examples/schema-catalog

crm / todo / kitchen-sink / msw-todo 四个目录都不存在。README 里另外两条(byo-backend-console、console-starter)是对的,而实际存在的 hello-world、schema-catalog 反过来没被 README 提到。

影响

README 是仓库门面。新用户点这四个链接会撞 GitHub 404,读到的却是四段言之凿凿的功能描述(CRM、Kanban、Map、Gantt、MSW…)。这比没写更糟。

这不是新缺陷,是一直没人跑

README.md 本来就在 check-links.yml 的扫描范围里 —— 也就是说这个 workflow 只要跑一次就会报出来。它是 workflow_dispatch-only(#3213 裁决 B),所以显然从来没被手动触发过。#3449 / PR #3477 给它加了每周 cron,以后这类问题会自己冒出来。

用 origin/main 当时的 args 和 config 实测(lychee 0.24.2):

[README.md]:
[ERROR] file://…/examples/crm            (at 59:5) | File not found.
[ERROR] file://…/examples/todo           (at 60:5) | File not found.
[ERROR] file://…/examples/kitchen-sink   (at 61:5) | File not found.
[ERROR] file://…/examples/msw-todo       (at 62:5) | File not found.

🔍 129 Total  🔗 104 Unique  ✅ 95 OK  🚫 4 Errors    (exit code 2)

建议的修法

需要知道这四个 example 的去向才能决定,不是机械删除:

  • 如果是被删了 / 合并进 console-starter 之类 → 删掉这四条,并把实际存在的 hello-world、schema-catalog 补进去;
  • 如果是移到了别的仓库 → 改成指向那个仓库的绝对链接;
  • 如果是计划中还没建 → 从 README 挪走,不要用现在时描述不存在的东西。

顺带把 README 的 Examples 列表和 examples/ 目录、examples/README.md 对一遍。

复现

lychee --offline --no-progress --config lychee.toml 'README.md'

Activity

  1. self-assigned this
    on Aug 6, 2026
  2. yinlianghui commented on Aug 6, 2026

    @yinlianghui
    CollaboratorAuthor

    认领:objectui 分片 PM 并行批第 55 单
    会话:session_01GTRjn8xBqp75dk7kFupVRt
    分支:claude/issue-3480-readme-examples
    Worktree:objectui-issue-3480
    文件面:README.md(Examples 小节)± examples/README.md(对账)。先查四个幽灵目录的 git 去向(被删/合并/移仓/从未存在),按 issue 三分法处置并逐条记出处;实际存在的 hello-world、schema-catalog 补进列表,描述以各自 README 为准不虚构。
    与同批各单互不相交(content/docs 归 54 单,勿碰)。


    Generated by Claude Code

  3. yinlianghui commented on Aug 6, 2026

    @yinlianghui
    CollaboratorAuthor

    验收:ACCEPT → PR #3485(并行批第 55 单,会话 session_01GTRjn8xBqp75dk7kFupVRt)。ready + auto-merge 因 GraphQL 配额排队,恢复即执行。

    复核要点:四个 verdict 均以 commit 级证据落地(同一删除提交 12b287d,零新增目录 = 非迁移;objectstack 同名示例早于删除三个月 = 独立非去向;app-showcase 晚三周且是后端覆盖夹具——拒绝发明链接的判断正确)。超出四链但在围栏内的两处扩展均合理:死掉的 serve 小节(全仓零 serve 脚本,留着就是文档教不存在的命令——正是本单要治的病)与 examples/README 的通用 dev 指令纠正(对 hello-world/schema-catalog 为假)。schema-catalog 按其自述放「非可运行」表而非 Runnable 行,描述零虚构。PR 正文消毒器坑被回读抓住并改写。#3486(hello-world README 同因幽灵链)finding 留池。


    Generated by Claude Code

  4. added a commit that references this issue on Aug 10, 2026
    f1b87fd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions