From 1d64fc52b07ea2ec88eda2181c4e301554ef7115 Mon Sep 17 00:00:00 2001 From: Doug Horner Date: Wed, 20 May 2026 15:46:07 -0400 Subject: [PATCH 1/2] docs(Table): direct users to DataVis NITRO for most table use cases Add a Storybook docs banner and JSDoc note on the Table component pointing users to DataVis NITRO. NITRO is simple out of the box while exposing power-user features progressively; Table should only be used in lightweight situations where that overhead is genuinely unneeded. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/components/Table/Table.stories.tsx | 6 ++++++ src/components/Table/Table.tsx | 3 +++ 2 files changed, 9 insertions(+) diff --git a/src/components/Table/Table.stories.tsx b/src/components/Table/Table.stories.tsx index 18e711c6..fc1fabc7 100644 --- a/src/components/Table/Table.stories.tsx +++ b/src/components/Table/Table.stories.tsx @@ -33,6 +33,12 @@ const meta: Meta = { component: Table, parameters: { layout: 'centered', + docs: { + description: { + component: + '> 💡 **Prefer [DataVis NITRO](?path=/docs/components-text-data-display-datavis-nitro--docs) in most cases.** NITRO is designed to be simple out of the box while exposing power-user features for the click-curious — use `Table` only in lightweight situations where that overhead is genuinely unneeded.', + }, + }, }, tags: ['autodocs'], argTypes: { diff --git a/src/components/Table/Table.tsx b/src/components/Table/Table.tsx index c73935c2..887abe5e 100644 --- a/src/components/Table/Table.tsx +++ b/src/components/Table/Table.tsx @@ -13,6 +13,9 @@ export interface TableProps extends React.TableHTMLAttributes /** * An accessible table component. * + * Prefer {@link ?path=/docs/components-text-data-display-datavis-nitro--docs DataVis NITRO} in most cases — it is simple out of the box + * while exposing power-user features for click-curious users. Use `Table` only in lightweight situations where that overhead is genuinely unneeded. + * * @example * ```tsx * From 210afea1a45548af172c9c6bd1d84e3f3d174180 Mon Sep 17 00:00:00 2001 From: Doug Horner Date: Wed, 20 May 2026 15:51:28 -0400 Subject: [PATCH 2/2] fix(Table): replace broken JSDoc {@link} with plain prose The Storybook path ?path=/docs/... is not a valid URL or symbol reference, so most JSDoc/TS renderers showed it as a broken link. Replace with plain prose that preserves the full guidance. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- src/components/Table/Table.tsx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/components/Table/Table.tsx b/src/components/Table/Table.tsx index 887abe5e..6496465f 100644 --- a/src/components/Table/Table.tsx +++ b/src/components/Table/Table.tsx @@ -13,8 +13,9 @@ export interface TableProps extends React.TableHTMLAttributes /** * An accessible table component. * - * Prefer {@link ?path=/docs/components-text-data-display-datavis-nitro--docs DataVis NITRO} in most cases — it is simple out of the box - * while exposing power-user features for click-curious users. Use `Table` only in lightweight situations where that overhead is genuinely unneeded. + * Prefer DataVis NITRO in most cases -- it is designed to be simple out of the box while + * exposing power-user features for click-curious users. Use `Table` only in lightweight + * situations where that overhead is genuinely unneeded. * * @example * ```tsx