review changes

code/addons/a11y/src/types.ts

@@ -15,7 +15,7 @@ export interface A11yParameters {
     /**
      * Configuration for the accessibility rules
      *
-     * @see https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter
+     * @see https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure
      */
     config?: Spec;
 
@@ -26,7 +26,7 @@ export interface A11yParameters {
      */
     options?: RunOptions;
 
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
   };
 }
@@ -39,8 +39,10 @@ export interface A11yGlobals {
    */
   a11y: {
     /**
-     * Prevent the addon to execute automatic accessibility checks upon visiting a story. You can
-     * still trigger the checks from the addon panel.
+     * Prevent the addon from executing automated accessibility checks upon visiting a story. You
+     * can still trigger the checks from the addon panel.
+     *
+     * @see https://storybook.js.org/docs/writing-tests/accessibility-testing#turn-off-automated-a11y-tests
      */
     manual?: boolean;
   };

code/addons/actions/src/types.ts

@@ -6,7 +6,7 @@ export interface ActionsParameters {
    */
   actions: {
     /**
-     * Create actions for each arg that matches the regex.
+     * Create actions for each arg that matches the regex. (**NOT recommended, see below**)
      *
      * This is quite useful when your component has dozens (or hundreds) of methods and you do not
      * want to manually apply the fn utility for each of those methods. However, this is not the
@@ -15,11 +15,11 @@ export interface ActionsParameters {
      * functions, you will need to also define args with the fn utility to test them in your play
      * function.
      *
-     * @example ArgTypesRegex: '^on.*'
+     * @example `argTypesRegex: '^on.*'`
      */
     argTypesRegex?: string;
 
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
 
     /**
@@ -27,7 +27,11 @@ export interface ActionsParameters {
      * and triggers an action when the event is called for a given selector. The format is
      * `<eventname> <selector>`. The selector is optional; it defaults to all elements.
      *
-     * @example Handles: ['mouseover', 'click .btn']
+     * **To enable this feature, you must use the `withActions` decorator.**
+     *
+     * @example `handles: ['mouseover', 'click .btn']`
+     *
+     * @see https://storybook.js.org/docs/essentials/actions#action-event-handlers
      */
     handles?: string[];
   };

code/addons/backgrounds/src/types.ts

@@ -32,7 +32,7 @@ export interface BackgroundsParameters {
     /** Default background color */
     default?: string;
 
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
 
     /** Configuration for the background grid */

code/addons/controls/src/types.ts

@@ -5,17 +5,13 @@ export interface ControlsParameters {
    * @see https://storybook.js.org/docs/essentials/controls#parameters-1
    */
   controls: {
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
 
     /** Disable the ability to create or edit stories from the Controls panel */
     disableSaveFromUI?: boolean;
 
-    /**
-     * Exclude specific properties from the Controls panel
-     *
-     * @see https://storybook.js.org/docs/essentials/controls#filtering-controls
-     */
+    /** Exclude specific properties from the Controls panel */
     exclude?: string[] | RegExp;
 
     /**
@@ -24,11 +20,7 @@ export interface ControlsParameters {
      */
     expanded?: boolean;
 
-    /**
-     * Exclude only specific properties in the Controls panel
-     *
-     * @see https://storybook.js.org/docs/essentials/controls#filtering-controls
-     */
+    /** Exclude only specific properties in the Controls panel */
     include?: string[] | RegExp;
 
     /**
@@ -36,16 +28,10 @@ export interface ControlsParameters {
      *
      * @example PresetColors: [{ color: '#ff4785', title: 'Coral' }, 'rgba(0, 159, 183, 1)',
      * '#fe4a49']
-     *
-     * @see https://storybook.js.org/docs/essentials/controls#specify-initial-preset-color-swatches
      */
     presetColors?: Array<string | { color: string; title?: string }>;
 
-    /**
-     * Controls sorting order
-     *
-     * @see https://storybook.js.org/docs/essentials/controls#sorting-controls
-     */
+    /** Controls sorting order */
     sort?: 'none' | 'alpha' | 'requiredFirst';
   };
 }

code/addons/docs/src/types.ts

@@ -5,7 +5,7 @@ type StoryBlockParameters = {
   autoplay?: boolean;
   /**
    * Set a minimum height (note for an iframe this is the actual height) when rendering a story in
-   * an iframe or inline. This overrides parameters.docs.story.iframeHeight for iframes.
+   * an iframe or inline. This overrides `parameters.docs.story.iframeHeight` for iframes.
    */
   height?: string;
   /** IFrame configuration */
@@ -18,7 +18,7 @@ type StoryBlockParameters = {
   /** Specifies the CSF file to which the story is associated */
   meta: ModuleExports;
   /**
-   * Specifies which story is rendered by the Story block. If no of is defined and the MDX file is
+   * Specifies which story is rendered by the Story block. If no `of` is defined and the MDX file is
    * attached, the primary (first) story will be rendered.
    */
   of: ModuleExport;
@@ -31,11 +31,7 @@ type ControlsBlockParameters = {
   /** Exclude only specific properties in the Controls panel */
   include?: string[] | RegExp;
 
-  /**
-   * Controls sorting order
-   *
-   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-controls#sort
-   */
+  /** Controls sorting order */
   sort?: 'none' | 'alpha' | 'requiredFirst';
 };
 
@@ -182,7 +178,7 @@ export interface DocsParameters {
      */
     description?: DescriptionBlockParameters;
 
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
 
     /**

code/addons/highlight/src/types.ts

@@ -5,7 +5,7 @@ export interface HighlightParameters {
    * @see https://storybook.js.org/docs/essentials/highlight#parameters
    */
   highlight: {
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
   };
 }

code/addons/interactions/src/preview.ts

@@ -20,6 +20,6 @@ export const runStep = instrument(
   // perhaps csf types need to be updated? StepRunner expects Promise<void> and not Promise<void> | void
 ).step as StepRunner;
 
-export const parameters: InteractionsParameters['interactions'] = {
+export const parameters: InteractionsParameters['test'] = {
   throwPlayFunctionExceptions: false,
 };

code/addons/interactions/src/types.ts

@@ -4,10 +4,7 @@ export interface InteractionsParameters {
    *
    * @see https://storybook.js.org/docs/essentials/interactions
    */
-  interactions: {
-    /** Turn off this addon's behavior */
-    disable?: boolean;
-
+  test: {
     /** Ignore unhandled errors during test execution */
     dangerouslyIgnoreUnhandledErrors?: boolean;
 

code/addons/measure/src/types.ts

@@ -5,7 +5,7 @@ export interface MeasureParameters {
    * @see https://storybook.js.org/docs/essentials/measure-and-outline#parameters
    */
   measure: {
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
   };
 }

code/addons/outline/src/types.ts

@@ -5,7 +5,7 @@ export interface OutlineParameters {
    * @see https://storybook.js.org/docs/essentials/measure-and-outline#parameters
    */
   outline: {
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
   };
 }

code/addons/storysource/src/types.ts

@@ -8,7 +8,7 @@ export interface StorySourceParameters {
     /** Dark mode for source code */
     dark?: boolean;
 
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
 
     /** Source code formatting options */

code/addons/test/src/types.ts

@@ -1,13 +1,10 @@
 export interface TestParameters {
   /**
-   * Interactions configuration
+   * Test addon configuration
    *
    * @see https://storybook.js.org/docs/writing-tests/test-addon
    */
   test: {
-    /** Turn off this addon's behavior */
-    disable?: boolean;
-
     /** Ignore unhandled errors during test execution */
     dangerouslyIgnoreUnhandledErrors?: boolean;
 

code/addons/themes/src/types.ts

@@ -10,7 +10,7 @@ export interface ThemesParameters {
    * @see https://github.com/storybookjs/storybook/blob/next/code/addons/themes/README.md
    */
   themes: {
-    /** Turn off this addon's behavior */
+    /** Remove the addon panel and disable the addon's behavior */
     disable?: boolean;
     /** Which theme to override for the story */
     themeOverride?: string;

code/addons/viewport/src/types.ts

@@ -59,8 +59,8 @@ export interface ViewportParameters {
     defaultViewport?: string;
 
     /**
-     * Turn off this addon's behavior. If you wish to turn off this addon for the entire Storybook,
-     * you should do so when registering addon-essentials
+     * Remove the addon panel and disable the addon's behavior . If you wish to turn off this addon
+     * for the entire Storybook, you should do so when registering addon-essentials
      *
      * @see https://storybook.js.org/docs/essentials/index#disabling-addons
      */

code/renderers/react/src/types.ts

@@ -18,7 +18,11 @@ export interface ShowErrorArgs {
 export interface ReactParameters {
   /** React renderer configuration */
   react?: {
-    /** Whether to enable React Server Components */
+    /**
+     * Whether to enable React Server Components
+     *
+     * @see https://storybook.js.org/docs/get-started/frameworks/nextjs#react-server-components-rsc
+     */
     rsc?: boolean;
     /** Options passed to React root creation */
     rootOptions?: {