Improved API and prop descriptions for 2025-07

linting

linting

linting

Author: mcvinci

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Badge.doc.ts

@@ -7,7 +7,7 @@ const generateCodeBlockForBadge = (title: string, fileName: string) =>
 const data: ReferenceEntityTemplateSchema = {
   name: 'Badge',
   description:
-    'Badges are used to inform merchants of the status of an item or action that’s been taken.',
+    'Use color and text to communicate the state of orders, products, customers, and other business data.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Banner.doc.ts

@@ -7,7 +7,7 @@ const generateCodeBlockForBanner = (title: string, fileName: string) =>
 const data: ReferenceEntityTemplateSchema = {
   name: 'Banner',
   description:
-    'A banner informs merchants about important changes or persistent conditions. Use if you need to communicate to merchants in a prominent way, without blocking other actions.',
+    'Highlight important information or required actions prominently within the POS interface.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Box.doc.ts

@@ -7,7 +7,7 @@ const generateCodeBlockForBanner = (title: string, fileName: string) =>
 const data: ReferenceEntityTemplateSchema = {
   name: 'Box',
   description:
-    'A box component is a container that can be used to group and display content in a consistent manner.',
+    'Display a generic container with consistent spacing and styling.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Button.doc.ts

@@ -6,7 +6,7 @@ const generateCodeBlockForButton = (title: string, fileName: string) =>
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'Button',
-  description: `Buttons enable the merchant to initiate actions, like "add", "save", or "next".
+  description: `Trigger actions or events, such as opening dialogs or navigating to other pages.
   > Note:
   > The \`plain\` \`ButtonType\` is no longer supported as of POS 10.0.0 and defaults to \`basic\`.`,
   isVisualComponent: true,

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/CameraScanner.doc.ts

@@ -7,7 +7,7 @@ const generateCodeBlockForCameraScanner = (title: string, fileName: string) =>
 const data: ReferenceEntityTemplateSchema = {
   name: 'CameraScanner',
   description:
-    'The camera scanner uses the devices camera to scan and decode barcodes or QR codes. It displays a live feed with guidance markers for alignment and triggers actions within the app upon successful recognition.',
+    'Provide camera-based scanning functionality with optional banner messaging.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/DateField.doc.ts

@@ -4,7 +4,7 @@ import {generateCodeBlock} from '../helpers/generateCodeBlock';
 const data: ReferenceEntityTemplateSchema = {
   name: 'DateField',
   description:
-    'A component that enables users to open a dialog and select a date through a text input.',
+    'Capture date input with a consistent interface for date selection and proper validation.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/DatePicker.doc.ts

@@ -7,7 +7,8 @@ const generateCodeBlockForDatePicker = (title: string, fileName: string) =>
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'DatePicker',
-  description: 'A component used to select a date through a dialog.',
+  description:
+    'Allow merchants to select a specific date using a calendar-like picker interface.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Dialog.doc.ts

@@ -6,8 +6,7 @@ const generateCodeBlockForDialog = (title: string, fileName: string) =>
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'Dialog',
-  description:
-    'A dialog is a high-priority, intentionally disruptive message that requires action from the merchant before they can continue using POS.',
+  description: 'Display a modal that requires user attention and interaction.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/EmailField.doc.ts

@@ -4,7 +4,7 @@ import {generateCodeBlock} from '../helpers/generateCodeBlock';
 const data: ReferenceEntityTemplateSchema = {
   name: 'EmailField',
   description:
-    'Use an email field to conveniently and accurately capture merchant email addresses.',
+    'Capture email address input from customers with built-in validation.',
   isVisualComponent: true,
   type: 'component',
   definitions: [

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/Icon.doc.ts

@@ -3,7 +3,8 @@ import {generateCodeBlock} from '../helpers/generateCodeBlock';
 
 const data: ReferenceEntityTemplateSchema = {
   name: 'Icon',
-  description: 'A component that renders an icon from the POS asset catalog.',
+  description:
+    'Display standardized visual symbols from the POS catalog to represent actions, statuses, or categories consistently.',
   isVisualComponent: true,
   type: 'component',
   definitions: [