Skip to content

docs(examples): 修复 hello-world README 指向已删除示例的两条死链 - #3495

Merged
yinlianghui merged 1 commit into
mainfrom
claude/issue-3486-helloworld-readme-links
Aug 6, 2026
Merged

docs(examples): 修复 hello-world README 指向已删除示例的两条死链#3495
yinlianghui merged 1 commit into
mainfrom
claude/issue-3486-helloworld-readme-links

Conversation

@yinlianghui

Copy link
Copy Markdown
Collaborator

Fixes #3486

背景

examples/hello-world/README.md 的 "Learn more" 三条里有两条是死链:../crm/../todo/ 指向的目录已在 12b287d(2026-05-02,refactor: remove example Todo application and related files)随 CRM/Todo 示例一并删除。hello-world 是入门示例,读者读完的第一跳就是这一节 —— 三条里两条 404。第三条 ../schema-catalog/ 仍有效。

改动

只改 examples/hello-world/README.md 一个文件,只改 "Learn more" 三行:

  • 删掉 ../crm/../todo/ 两条;
  • examples/README.md 的 "Rule of thumb" 进阶路径补上现存的两个可运行示例(顺序即该路径顺序:hello-world 之后 → 接入已有产品 → 从零起 console);
  • ../schema-catalog/ 原样保留。

描述不臆造,逐条取自仓库内既有材料:

新增条目 描述出处
../byo-backend-console/ 其 README(~100 lines、自定义 DataSource + router、mock REST 而非 ObjectStack)与 examples/README.md 表格行("embed ObjectUI into your own app and connect it to your own REST/GraphQL backend")
../console-starter/ 该目录没有 README,故取 package.jsondescription("Opinionated, fork-ready console template built on @object-ui/app-shell with the full plugin set wired up.")与 examples/README.md 表格行

验证

按 PR #3485 的做法,对改后文件做离线相对链接解析(把每个相对 href 落到文件系统上):

改前(git show origin/main:examples/hello-world/README.md):

File-not-found  ----  [CRM Example](../crm/)
File-not-found  ----  [Todo Example](../todo/)
OK    dir   [Schema Catalog](../schema-catalog/)
relative links checked: 3
File-not-found: 2

改后:

OK    dir   [BYO Backend Console](../byo-backend-console/)
OK    dir   [Console Starter](../console-starter/)
OK    dir   [Schema Catalog](../schema-catalog/)
relative links checked: 3
File-not-found: 0

方向是事先定好的:死链修复应当"改前红、改后绿",实际即如此。

其余检查:

  • markdown 代码围栏配平:4 行围栏 = 2 对(12/18、22/27),均在本次改动之外;
  • 控制字节自扫 grep -naP '[\x00-\x08\x0b\x0c\x0e-\x1f]' → 无命中,fileUnicode text, UTF-8 text;
  • pnpm check:control-bytesOK (scanned 3674 tracked text file(s); skipped 85 binary);
  • pnpm docs:check-linksDocs links are valid.(说明:该 gate 只走 content/docs 且只校验 /docs 开头的路由,examples/**/README.md 的相对链接根本不在其扫描面内 —— 这正是这两条死链能存活三个月的原因,已另行记录,不在本 PR 处理)

docs-only,无 changeset。ROADMAP.md / CHANGELOG.md 的历史记录未动;content/docs 的同类死链归 #3490,本 PR 不碰。


Generated by Claude Code

../crm/ 与 ../todo/ 两个目录已在 12b287d(2026-05-02)随 Todo/CRM 示例移除,
README 的 "Learn more" 仍指向它们,入门读者第一跳即 404。

按 examples/README.md 的 rule of thumb 进阶路径替换为现存的两个示例:
- byo-backend-console:接入已有产品 / 自有后端
- console-starter:从零起一个 ObjectStack console

描述取自各自 README 与 package.json,未臆造;../schema-catalog/ 原样保留。

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

vercel Bot commented Aug 6, 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 6, 2026 1:17pm

Request Review

@yinlianghui
yinlianghui marked this pull request as ready for review August 6, 2026 13:51
@yinlianghui
yinlianghui added this pull request to the merge queue Aug 6, 2026
Merged via the queue into main with commit f904fa6 Aug 6, 2026
6 checks passed
@yinlianghui
yinlianghui deleted the claude/issue-3486-helloworld-readme-links branch August 6, 2026 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants