Skip to content

docs: content/docs/ui/translations.mdx does not list the dashboard widget node's subCaption key (follow-up to #7862) #8052

Description

@huangyiirene

Found while implementing #7862 (dispatch file surface excluded hand-written docs; filed rather than scope-expanded).

#7862 adds dashboards.{name}.widgets.{widgetId}.subCaption (angle brackets avoided for the body sanitizer; read {name} as the dashboard name placeholder) to the widget translation node — the metric widget's sub-caption (options.description, a different authored field from widget.description, per the #5428 item-4 ruling 「两个作者字段两个 key」) — and re-points the node's subtitle alias from description to subCaption.

The hand-written guide content/docs/ui/translations.mdx documents the translation key faces (its table today carries the pages face rows around lines 76–91, and the dashboards face is described nearby). It should gain the widget subCaption row so authors learn the key from the guide rather than from the parse error, and any prose saying widgets carry "title/description" should say three members.

The generated reference (content/docs/references/system/translation.mdx) needs nothing — it truncates the widget node's inner shape at object and is verified unchanged by check:docs on the #7862 branch.

Blocked-by: #7862 (document the key only once it exists on main).


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