Skip to content

Commit 18dbdbe

Browse files
authored
Merge pull request #77 from nkabrown/update-storybook-links
Update links to Storybook documentation
2 parents bdaeaf3 + adfd56a commit 18dbdbe

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

src/story.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -341,33 +341,33 @@ export interface BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs =
341341
* Wrapper components or Storybook decorators that wrap a story.
342342
*
343343
* Decorators defined in Meta will be applied to every story variation.
344-
* @see [Decorators](https://storybook.js.org/docs/addons/introduction/#1-decorators)
344+
* @see [Decorators](https://storybook.js.org/docs/writing-stories/decorators)
345345
*/
346346
decorators?:
347347
| DecoratorFunction<TRenderer, Simplify<TArgs>>[]
348348
| DecoratorFunction<TRenderer, Simplify<TArgs>>;
349349

350350
/**
351351
* Custom metadata for a story.
352-
* @see [Parameters](https://storybook.js.org/docs/basics/writing-stories/#parameters)
352+
* @see [Parameters](https://storybook.js.org/docs/writing-stories/parameters)
353353
*/
354354
parameters?: Parameters;
355355

356356
/**
357357
* Dynamic data that are provided (and possibly updated by) Storybook and its addons.
358-
* @see [Arg story inputs](https://storybook.js.org/docs/react/api/csf#args-story-inputs)
358+
* @see [Args](https://storybook.js.org/docs/writing-stories/args)
359359
*/
360360
args?: Partial<TArgs>;
361361

362362
/**
363363
* ArgTypes encode basic metadata for args, such as `name`, `description`, `defaultValue` for an arg. These get automatically filled in by Storybook Docs.
364-
* @see [Control annotations](https://github.com/storybookjs/storybook/blob/91e9dee33faa8eff0b342a366845de7100415367/addons/controls/README.md#control-annotations)
364+
* @see [ArgTypes](https://storybook.js.org/docs/api/arg-types)
365365
*/
366366
argTypes?: Partial<ArgTypes<TArgs>>;
367367

368368
/**
369369
* Asynchronous functions which provide data for a story.
370-
* @see [Loaders](https://storybook.js.org/docs/react/writing-stories/loaders)
370+
* @see [Loaders](https://storybook.js.org/docs/writing-stories/loaders)
371371
*/
372372
loaders?: LoaderFunction<TRenderer, TArgs>[] | LoaderFunction<TRenderer, TArgs>;
373373

@@ -438,7 +438,7 @@ export interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TAr
438438
* title: 'Design System/Atoms/Button'
439439
* }
440440
*
441-
* @see [Story Hierarchy](https://storybook.js.org/docs/basics/writing-stories/#story-hierarchy)
441+
* @see [Story Hierarchy](https://storybook.js.org/docs/writing-stories/naming-components-and-hierarchy#structure-and-hierarchy)
442442
*/
443443
title?: ComponentTitle;
444444

@@ -447,7 +447,7 @@ export interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TAr
447447
*
448448
* By default is inferred from sanitizing the title
449449
*
450-
* @see [Story Hierarchy](https://storybook.js.org/docs/basics/writing-stories/#story-hierarchy)
450+
* @see [Permalink to stories](https://storybook.js.org/docs/configure/sidebar-and-urls#permalink-to-stories)
451451
*/
452452
id?: ComponentId;
453453

@@ -457,7 +457,7 @@ export interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TAr
457457
* includeStories: ['SimpleStory', 'ComplexStory']
458458
* includeStories: /.*Story$/
459459
*
460-
* @see [Non-story exports](https://storybook.js.org/docs/formats/component-story-format/#non-story-exports)
460+
* @see [Non-story exports](https://storybook.js.org/docs/api/csf#non-story-exports)
461461
*/
462462
includeStories?: StoryDescriptor;
463463

@@ -467,7 +467,7 @@ export interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TAr
467467
* excludeStories: ['simpleData', 'complexData']
468468
* excludeStories: /.*Data$/
469469
*
470-
* @see [Non-story exports](https://storybook.js.org/docs/formats/component-story-format/#non-story-exports)
470+
* @see [Non-story exports](https://storybook.js.org/docs/api/csf#non-story-exports)
471471
*/
472472
excludeStories?: StoryDescriptor;
473473

0 commit comments

Comments
 (0)