Skip to content

[finding] quick-reference.mdx 的协议索引与 packages/spec 现状漂移:三处小节计数不符 + connector-auth 有 schema 无参考页 #6319

Description

@hotlong

在做 #6028(恢复 Check Links 断链门)时,门首次真正运行暴露了 content/docs/getting-started/quick-reference.mdx 里的断链;逐条核对时顺带发现该页还有几处与 packages/spec 现状不符的地方,非本单范围,按 Prime Directive #10 独立记录。

⚠️ 这些不是断链,Check Links 抓不到它们(lychee 只检可达性)。#6028 的 PR 只改了链接目标行,下面这些原样保留。

观察一:三处小节计数与实际行数不符(#6028 之前就存在)

该页每个小节标题带 (N schemas),实测(在 #6028 的改动之前origin/main 上按 | ** 开头的表格行计数):

小节 标题声明 实际行数
Kernel Protocol 17 15
Cloud Protocol 5 6
Shared Protocol 5 12

其余 8 个小节当时都对得上。⚠️ 注意 System(19)与 API(19)两处在 #6028 里由我改成了 18 / 17 —— 那是因为该 PR 删掉了三行指向已退役 schema 的表项(audit / registry / graphql),属于同步修正,不在本单记录范围内;上表三处与 #6028 无关。

Shared 差了 7 行,不像笔误,更像该小节扩充过而标题没跟。

观察二:connector-auth 有 schema、无参考页

packages/spec/src/shared/connector-auth.zod.ts 存在,但 content/docs/references/shared/ 下只有 branded-types.mdx / enums.mdx / expression.mdx / http.mdx —— 没有 connector-auth.mdx

quick-reference 里原本有一行链到 /docs/references/shared/connector-auth,那是一条真断链;#6028 的处置是保留该行、去掉链接(schema 确实存在,信息不该丢),所以这一行今天读起来是"有这个 schema,但没有参考页可看"。页要不要补,留待分诊

未判定的部分

没有查这个索引页是手写的还是某个脚本生成的。文件头没有 AUTO-GENERATED 标记(content/docs/references/** 下的生成物都有),所以看起来是手写维护的 —— 若确实手写,那这类漂移会反复发生,可能值得一道计数校验;若其实有生成器,那就是生成器该修。请分诊时以实际为准。

影响面(据实,不夸大)

读者看到的是一个数字对不上的目录和一行没有出口的条目 —— 不会导致任何运行时错误,也没有已知用户因此踩坑。归类为 observation-class,不加 pm:queue,留待分诊定级。


Generated by Claude Code

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions