Skip to content

examples/hello-world/README.md 的 "Learn more" 指向两个已删除的示例目录(../crm/、../todo/) #3486

Description

@yinlianghui

在修 #3480(根 README 推荐 4 个不存在的 example)时顺带发现的同类漂移,因不在那次派发的文件围栏内,单独记录。

现象

examples/hello-world/README.md:31-32:

- [CRM Example](../crm/) — full-featured reference app
- [Todo Example](../todo/) — ObjectStack protocol basics
- [Schema Catalog](../schema-catalog/) — canonical JSON schemas used across docs & tests

前两条指向的 examples/crm/examples/todo/ 都不存在。第三条 ../schema-catalog/ 是有效的。

成因

#3480 同源:这两个目录在提交 12b287d8b("refactor: remove example Todo application and related files", 2026-05-02)中被删除,该提交没有同步更新任何引用它们的 README。

examples/todo/README.md 当年也反向引用过 CRM("see the CRM Example (../crm/)"),整组互链在删除时一起失效,只是 hello-world 这份活了下来。

影响

低,但是用户可见:hello-world 是文档和根 README 都推荐的入门示例,读者读完第一件事就是点 "Learn more",两条里有两条是死链。lychee 若把扫描面扩到 examples/**/*.md 会直接报 File-not-found。

建议修法

删掉前两条,保留 ../schema-catalog/,并按实际情况补 ../byo-backend-console/../console-starter/(这正是 examples/README.md 里 "rule of thumb" 给出的进阶路径:hello-world → byo-backend-console → console-starter)。描述应取自各自 README,不要臆造。

备注

发现于 PR #3485(修 #3480)。

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions