Skip to content

finding(docs): plugin-dashboard README 有两个同名 H2「DashboardGridLayout — persisting drag / resize edits」,DashboardRenderer 一节夹在第一个下面 #5095

Description

@yinlianghui

发现于 #5066 + #5064 文档半的实施(PR #5093)。Filed unassigned, not claiming。Observation class:纯结构/观感,读者拿不到错的代码或错的键,所以按纪律带 finding 标签、不带 pm:queue,严重度交分诊评。

现象

packages/plugin-dashboard/README.md 里同一个 H2 出现两次(行号取 PR #5093 合入后的分支状态):

:480  ## DashboardGridLayout — persisting drag / resize edits
:482  ### DashboardRenderer — design-mode widget reorder
:495  ## DashboardGridLayout — persisting drag / resize edits

第一个 H2 下面接的是 DashboardRenderer 的 design-mode 拖拽重排一节(onWidgetsReorder / dnd-kit),与标题所写的「DashboardGridLayout 的持久化」无关;真正讲持久化的正文在第二个同名 H2 之后。所以读者(以及所有按标题建目录的渲染器 / 锚点生成器)会看到一个重复标题,并且第一个标题对它下面的内容是错的。

看起来的成因:DashboardRenderer 那一节是后插进来的,插点落在 H2 之后而不是之前。最小修法是把 ### DashboardRenderer … 一节移到第一个 H2 之前(或给它自己的 H2),然后删掉重复的那个 H2 —— 一处纯文档结构改动,不动任何代码块。

⛔ 未在 PR #5093 里顺手修:那个 PR 的范围是 #5066onSchemaChange 示例与 #5064 的手动注册段两块,本条与两者都无关,按 Prime Directive #10 另立。

同族

#4517 是同一形状的另一处(plugin-calendar 文档的「ObjectCalendar Component」标题与引言整段重复),不是同一文件,故不作为重复卡而列为同族。

复核方式

grep -n "^## DashboardGridLayout" packages/plugin-dashboard/README.md
grep -n "^### DashboardRenderer" packages/plugin-dashboard/README.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfinding

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions