Skip to content

docs: document the widget subCaption translation key - #8395

Merged
qq9340100 merged 1 commit into
mainfrom
claude/issue-8052-translations-subcaption-row
Aug 13, 2026
Merged

docs: document the widget subCaption translation key#8395
qq9340100 merged 1 commit into
mainfrom
claude/issue-8052-translations-subcaption-row

Conversation

@qq9340100

Copy link
Copy Markdown
Collaborator

Fixes#8052

Adds the dashboard widget node's subCaption translation key to
content/docs/ui/translations.mdx (follow-up to #7862, which landed the key
on main without a docs update).

What changed

  • The "What you can translate" table's single dashboards.{name} row never
    enumerated the widget node's own keys. Split it into a dashboard-level row
    (label / description) and a widget row listing all three members:
    title / description / subCaption
    (dashboards.{name}.widgets.{widgetId}.*).
  • Added a callout explaining that a widget's subtitle alias now resolves to
    subCaption, not description — the metric widget's sub-caption
    (options.description) is a different authored field from the widget's own
    description, so each gets its own key per the objectui: dashboard KPI cards drop the translated widget title/description — the self-contained metric path bypasses tWidgetTitle, and the plugin's private resolveLabel never calls t() #5428 item-4 ruling
    (「两个作者字段两个 key」).
  • Grepped the rest of the guide for other "widgets carry title/description"
    prose per the unlock comment's warning — the table row was the only mention
    of widgets in the file, so no second edit site existed.

Not touched

content/docs/references/system/translation.mdx (the generated reference)
needed no change — it truncates the widget node's inner shape at object,
verified unchanged on this branch.

Verification

  • pnpm check:docs-audit-scope — pass
  • pnpm check:quick-reference-counts — pass
  • pnpm check:role-word — pass
  • pnpm --filter @objectstack/lint run check:doc-formula-expressions — pass
    (after pnpm --filter '@objectstack/lint^...' build, needed once in a
    fresh worktree for @objectstack/formula's dist output)
  • pnpm check:nul-bytes — pass
  • Re-derived gates against the actual changed path via
    node scripts/pm/dispatch-gates.mjs content/docs/ui/translations.mdx — same
    four families, no additional family surfaced.

Generated by Claude Code


Generated by Claude Code

The "What you can translate" table's dashboard row only ever said
`dashboards.<name>` — it never enumerated the widget node's keys, so authors
had no way to learn `subCaption` (added by #7862 for the metric widget's
sub-caption, `options.description`) from the guide. Split the row into a
dashboard-level row and a widget row listing `title` / `description` /
`subCaption`, and add a callout explaining that a widget's `subtitle` alias
now resolves to `subCaption`, not `description` — two different authored
fields, two keys, per the #5428 item-4 ruling.
Part of #8052
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Jqe56GnYFddggeAyfkZFVz
@vercel

vercelBot commented Aug 13, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectstackIgnoredIgnoredAug 13, 2026 11:01am

Request Review

@github-actionsgithub-actionsBot added size/s documentation Improvements or additions to documentation labels Aug 13, 2026
@qq9340100qq9340100 added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Aug 13, 2026 — with Claude
@qq9340100
qq9340100 marked this pull request as ready for review August 13, 2026 11:18
@qq9340100
qq9340100 added this pull request to the merge queueAug 13, 2026
Merged via the queue into main with commit b432ae4Aug 13, 2026
25 checks passed
@qq9340100
qq9340100 deleted the claude/issue-8052-translations-subcaption-row branch August 13, 2026 11:35
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationsize/sskip-changesetPR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants

@qq9340100@claude