Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs: remove em-dashes from doc prose and a duplicate (required) marker (#3260)

Joey59718fda3984
diff --git a/packages/cli/docs/theme.doc.mjs b/packages/cli/docs/theme.doc.mjs
index 6490565438..b6dd4df63b 100644
--- a/packages/cli/docs/theme.doc.mjs
+++ b/packages/cli/docs/theme.doc.mjs
@@ -53,7 +53,7 @@ function App() {
},
{
type: 'prose',
- text: 'Each theme ships as its own npm package. Install the one you want, then wrap your app in `<Theme>` — the same pattern works for every theme; just swap the package and import name.',
+ text: 'Each theme ships as its own npm package. Install the one you want, then wrap your app in `<Theme>`. The same pattern works for every theme; just swap the package and import name.',
},
{
type: 'prose',
@@ -261,7 +261,7 @@ const brandTheme = defineTheme({
content: [
{
type: 'prose',
- text: 'The `components` field in defineTheme uses semantic component keys and style keys — not raw CSS selectors. Use `base` for all instances, `variant:value` or `stateName` for specific props/states, and let the theme pipeline choose the underlying selector. For raw external CSS escape hatches, prefer the data-attribute selector surface documented in `astryx docs styling`.',
+ text: 'The `components` field in defineTheme uses semantic component keys and style keys, not raw CSS selectors. Use `base` for all instances, `variant:value` or `stateName` for specific props/states, and let the theme pipeline choose the underlying selector. For raw external CSS escape hatches, prefer the data-attribute selector surface documented in `astryx docs styling`.',
},
{
type: 'code',
diff --git a/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.doc.mjs b/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.doc.mjs
index 5b60e25aa6..c2c77c759d 100644
--- a/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.doc.mjs
+++ b/packages/cli/templates/blocks/components/LinkProvider/LinkProviderCustomLink.doc.mjs
@@ -7,7 +7,7 @@ export const doc = {
name: 'Link Provider — Custom Link Component',
displayName: 'Link Provider — Custom Link Component',
description:
- 'Routes every Astryx link through a custom component that intercepts the click — the hook frameworks like Next.js use for client-side navigation. Click the link to see the custom handler fire instead of a full-page load.',
+ 'Routes every Astryx link through a custom component that intercepts the click, the hook frameworks like Next.js use for client-side navigation. Click the link to see the custom handler fire instead of a full-page load.',
isReady: true,
aspectRatio: 4 / 3,
componentsUsed: ['LinkProvider', 'Link'],
diff --git a/packages/cli/templates/blocks/components/Table/StickyColumnsHookUsage.doc.mjs b/packages/cli/templates/blocks/components/Table/StickyColumnsHookUsage.doc.mjs
index 3cfb0aceb0..d2266b6bad 100644
--- a/packages/cli/templates/blocks/components/Table/StickyColumnsHookUsage.doc.mjs
+++ b/packages/cli/templates/blocks/components/Table/StickyColumnsHookUsage.doc.mjs
@@ -7,7 +7,7 @@ export const doc = {
name: 'useTableStickyColumns — Pinned Columns',
displayName: 'useTableStickyColumns — Pinned Columns',
description:
- 'A Table using useTableStickyColumns to pin the Name column to the start edge and Status to the end edge. Scroll horizontally — pinned columns stay in view with a soft shadow over the scrolling content.',
+ 'A Table using useTableStickyColumns to pin the Name column to the start edge and Status to the end edge. Scroll horizontally; pinned columns stay in view with a soft shadow over the scrolling content.',
isReady: true,
aspectRatio: 16 / 9,
componentsUsed: ['Table'],
diff --git a/packages/cli/templates/pages/shell-side-nav/template.doc.mjs b/packages/cli/templates/pages/shell-side-nav/template.doc.mjs
index 0b2c935252..6811df57c4 100644
--- a/packages/cli/templates/pages/shell-side-nav/template.doc.mjs
+++ b/packages/cli/templates/pages/shell-side-nav/template.doc.mjs
@@ -6,7 +6,7 @@ export const doc = {
name: 'Side Nav',
displayName: 'Side Nav',
description:
- 'A side-nav app shell with a collapsible, resizable SideNav — new chat, search, library, and workspace-grouped conversations with status dots — over static grey-card conversation and composer placeholders.',
+ 'A side-nav app shell with a collapsible, resizable SideNav (new chat, search, library, and workspace-grouped conversations with status dots) over static grey-card conversation and composer placeholders.',
isReady: true,
category: 'Shell - Left Sidebar',
};
diff --git a/packages/cli/templates/pages/shell-top-nav/template.doc.mjs b/packages/cli/templates/pages/shell-top-nav/template.doc.mjs
index 10dbba35c2..b1732c65fd 100644
--- a/packages/cli/templates/pages/shell-top-nav/template.doc.mjs
+++ b/packages/cli/templates/pages/shell-top-nav/template.doc.mjs
@@ -6,7 +6,7 @@ export const doc = {
name: 'Top Nav',
displayName: 'Top Nav',
description:
- 'A top-nav app shell with a centered TopNav — Shop and Brands mega menus (a 2x4 item grid plus a featured card each), Sale/Service links, and a Checkout button — over static grey-card hero and category sections.',
+ 'A top-nav app shell with a centered TopNav (Shop and Brands mega menus with a 2x4 item grid plus a featured card each, Sale/Service links, and a Checkout button) over static grey-card hero and category sections.',
isReady: true,
category: 'Shell - Top Nav',
};
diff --git a/packages/core/src/Table/useTableColumnResize.doc.mjs b/packages/core/src/Table/useTableColumnResize.doc.mjs
index 54f12f53bd..cdd7843b21 100644
--- a/packages/core/src/Table/useTableColumnResize.doc.mjs
+++ b/packages/core/src/Table/useTableColumnResize.doc.mjs
@@ -19,7 +19,7 @@ export const docs = {
name: 'onColumnResizeEnd',
type: '(updates: Record<string, number>) => void',
description:
- 'Called when a resize completes (pointerup / Enter). Receives a map of every column key whose width changed — merge it into your columnWidths state.',
+ 'Called when a resize completes (pointerup / Enter). Receives a map of every column key whose width changed; merge it into your columnWidths state.',
},
{
name: 'minWidth',
@@ -37,7 +37,7 @@ export const docs = {
name: 'columns',
type: 'TableColumn<T>[]',
description:
- 'Column definitions — needed to derive per-column min widths and detect proportional vs pixel columns for neighbor/last-column resize behavior.',
+ 'Column definitions, needed to derive per-column min widths and detect proportional vs pixel columns for neighbor/last-column resize behavior.',
},
],
};
@@ -91,6 +91,6 @@ export const docsDense = {
minWidth: 'Global min column width (px) during resize.',
maxWidth: 'Global max column width (px) during resize. Default Infinity.',
columns:
- 'Column defs — derive per-column mins + proportional/pixel detection for neighbor/last-column behavior.',
+ 'Column defs: derive per-column mins + proportional/pixel detection for neighbor/last-column behavior.',
},
};
diff --git a/packages/core/src/Table/useTableStickyColumns.doc.mjs b/packages/core/src/Table/useTableStickyColumns.doc.mjs
index 0a142d8acd..213bbca1c8 100644
--- a/packages/core/src/Table/useTableStickyColumns.doc.mjs
+++ b/packages/core/src/Table/useTableStickyColumns.doc.mjs
@@ -13,13 +13,13 @@ export const docs = {
name: 'startKeys',
type: 'string[]',
description:
- 'Column keys pinned to the start (inline-start / left in LTR) edge — the contiguous run from the first column through the last listed key.',
+ 'Column keys pinned to the start (inline-start / left in LTR) edge: the contiguous run from the first column through the last listed key.',
},
{
name: 'endKeys',
type: 'string[]',
description:
- 'Column keys pinned to the end (inline-end / right in LTR) edge — the contiguous run from the first listed key through the last column.',
+ 'Column keys pinned to the end (inline-end / right in LTR) edge: the contiguous run from the first listed key through the last column.',
},
],
};
diff --git a/packages/lab/src/CircularProgress/CircularProgress.doc.mjs b/packages/lab/src/CircularProgress/CircularProgress.doc.mjs
index d50cc993c3..a2ddaf49b4 100644
--- a/packages/lab/src/CircularProgress/CircularProgress.doc.mjs
+++ b/packages/lab/src/CircularProgress/CircularProgress.doc.mjs
@@ -22,7 +22,7 @@ export const docs = {
{
name: 'label',
type: 'string',
- description: 'Accessible label for screen readers (required).',
+ description: 'Accessible label for screen readers.',
required: true,
},
{
@@ -164,7 +164,7 @@ export const docsDense = {
propDescriptions: {
value: 'Current value. Omit for indeterminate spinning animation.',
max: 'Maximum value.',
- label: 'Accessible label for screen readers (required).',
+ label: 'Accessible label for screen readers.',
isLabelHidden: 'Visually hide label (remains accessible). Defaults to true.',
children: 'Center content: percentage, icon, or custom.',
size: 'Ring diameter (32px, 48px, 64px).',