Skip to content

Commit 694aa14

Browse files
betegonclaude
andcommitted
docs(dashboard): list all display types with sizes in widget help and types command
The widget --help and widget types --help now show all 14 display types with their default grid dimensions, matching the agent guidance table. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 24966db commit 694aa14

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

src/commands/dashboard/widget/index.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,11 @@ export const widgetRoute = buildRouteMap({
1515
brief: "Manage dashboard widgets",
1616
fullDescription:
1717
"Add, edit, or delete widgets in a Sentry dashboard.\n\n" +
18-
"Dashboards use a 6-column grid. Widget widths should sum to 6 per row.\n" +
19-
"Common display types: big_number (2 cols), line/area/bar (3 cols), table (6 cols).\n" +
18+
"Dashboards use a 6-column grid. Widget widths should sum to 6 per row.\n\n" +
19+
"Display types (width × height):\n" +
20+
" common: big_number (2×1), line (3×2), area (3×2), bar (3×2), table (6×2)\n" +
21+
" specialized: stacked_area (3×2), top_n (3×2), categorical_bar (3×2), text (3×2)\n" +
22+
" internal: details, wheel, rage_and_dead_clicks, server_tree, agents_traces_table (3×2)\n\n" +
2023
"Default dataset: spans. Run 'sentry dashboard widget types' for the full list.\n\n" +
2124
"Commands:\n" +
2225
" add Add a widget to a dashboard\n" +

src/commands/dashboard/widget/types.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,10 @@ export const typesCommand = buildCommand({
6767
"and aggregate functions.\n\n" +
6868
"Sentry dashboards use a 6-column grid. When adding widgets, aim to fill " +
6969
"complete rows (widths should sum to 6).\n\n" +
70-
"Display types are categorized as:\n" +
71-
" common — general-purpose (big_number, line, area, bar, table)\n" +
72-
" specialized — for specific use cases (stacked_area, top_n, categorical_bar, text)\n" +
73-
" internal — Sentry-internal, rarely used directly\n\n" +
70+
"Display types (width × height):\n" +
71+
" common: big_number (2×1), line (3×2), area (3×2), bar (3×2), table (6×2)\n" +
72+
" specialized: stacked_area (3×2), top_n (3×2), categorical_bar (3×2), text (3×2)\n" +
73+
" internal: details, wheel, rage_and_dead_clicks, server_tree, agents_traces_table (3×2)\n\n" +
7474
"Examples:\n" +
7575
" sentry dashboard widget types\n" +
7676
" sentry dashboard widget types --json",

0 commit comments

Comments
 (0)