Skip to content

Commit

Permalink
Remove /<renderer> from URLs in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kylegach committed Nov 27, 2023
1 parent cfc740c commit 8b2fa15
Show file tree
Hide file tree
Showing 365 changed files with 446 additions and 446 deletions.
2 changes: 1 addition & 1 deletion docs/essentials/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Storybook's [Themes](https://github.com/storybookjs/storybook/tree/next/code/add

## Theme decorators

To make your themes accessible to your stories, `@storybook/addon-themes` exposes three [decorators](https://storybook.js.org/docs/react/writing-stories/decorators) for different methods of theming.
To make your themes accessible to your stories, `@storybook/addon-themes` exposes three [decorators](https://storybook.js.org/docs/writing-stories/decorators) for different methods of theming.

### JSX providers

Expand Down
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ We're working on overcoming this limitation, and soon you'll be able to use them

Storybook does not work unless you have at least one local story (or docs page) defined in your project. In this context, local means a `.stories.*` or `.mdx` file that is referenced in your project's `.storybook/main.js` config.
If you're in a [Storybook composition](https://storybook.js.org/docs/react/sharing/storybook-composition) scenario, where you have multiple Storybooks, and want to have an extra Storybook with no stories of its own, that serves as a "glue" for all the other Storybooks in a project for demo/documentation purposes, you can do the following steps:
If you're in a [Storybook composition](https://storybook.js.org/docs/sharing/storybook-composition) scenario, where you have multiple Storybooks, and want to have an extra Storybook with no stories of its own, that serves as a "glue" for all the other Storybooks in a project for demo/documentation purposes, you can do the following steps:

Introduce a single `.mdx` docs page (addon-essentials or addon-docs required), that serves as an Introduction page, like so:

Expand Down Expand Up @@ -507,7 +507,7 @@ import type { ComponentStory, ComponentMeta } from '@storybook/react';
const StoryMeta: ComponentMeta<typeof Button> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/react/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Button',
Expand Down
2 changes: 1 addition & 1 deletion docs/sharing/storybook-composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ If you're using Storybook 6.4, or higher, you can optimize your composition via

<Callout variant="info" icon="💡">

If you already enabled automatic code splitting via the [`storyStoreV7`](https://storybook.js.org/docs/react/builders/webpack#code-splitting), you won't need this flag as it will automatically generate the `index.json` file.
If you already enabled automatic code splitting via the [`storyStoreV7`](https://storybook.js.org/docs/builders/webpack#code-splitting), you won't need this flag as it will automatically generate the `index.json` file.

</Callout>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
```shell
# Builds Storybook with Angular's custom builder
# See https://storybook.js.org/docs/angular/get-started/install
# See https://storybook.js.org/docs/get-started/install
# to learn how to create the custom builder
ng run my-project:build-storybook
```
2 changes: 1 addition & 1 deletion docs/snippets/angular/button-story-default-export.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Button } from './button.component';

const meta: Meta<Button> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Button',
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/button-story-grouped.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Button } from './button.component';

const meta: Meta<Button> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Design System/Atoms/Button',
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/button-story-hoisted.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Button as ButtonComponent } from './button.component';

const meta: Meta<ButtonComponent> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Design System/Atoms/Button',
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/button-story-rename-story.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type Story = StoryObj<Button>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
export const Primary: Story = {
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/angular/button-story-with-addon-example.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Button } from './button.component';

const meta: Meta<Button> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Button',
Expand All @@ -25,7 +25,7 @@ type Story = StoryObj<Button>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
export const Basic: Story = {
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/button-story-with-emojis.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type Story = StoryObj<Button>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
export const Primary: Story = {
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/button-story-with-parameters.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Button } from './button.component';

const meta: Meta<Button> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Button',
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/button-story.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type Story = StoryObj<Button>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
export const Primary: Story = {
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/checkbox-story-grouped.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Checkbox } from './checkbox.component';

const meta: Meta<Checkbox> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Design System/Atoms/Checkbox',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { MyComponent } from './MyComponent.component';

/**
* Story written in CSF 3.0 with auto title generation
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn more about it.
*/
const meta: Meta<MyComponent> = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type { Meta, StoryObj } from '@storybook/angular/';

import { MyComponent } from './MyComponent.component';

// More on default export: https://storybook.js.org/docs/angular/writing-stories/introduction#default-export
// More on default export: https://storybook.js.org/docs/writing-stories/introduction#default-export
const meta: Meta<MyComponent> = {
component: MyComponent,
};
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/foo-bar-baz-story.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Foo } from './Foo.component';

const meta: Meta<Foo> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Foo/Bar',
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/list-story-reuse-data.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ type Story = StoryObj<List>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
export const ManyItems: Story = {
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/angular/list-story-template.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { Unchecked } from './ListItem.stories';

const meta: Meta<List> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'List',
Expand All @@ -33,7 +33,7 @@ type Story = StoryObj<List>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
const ListTemplate: Story = {
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/angular/list-story-unchecked.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { Unchecked } from './ListItem.stories';

const meta: Meta<List> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'List',
Expand All @@ -33,7 +33,7 @@ type Story = StoryObj<List>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
export const OneItem: Story = {
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/loader-story.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ type Story = StoryObj<TodoItem>;

/*
*👇 Render functions are a framework specific feature to allow you control on how the component renders.
* See https://storybook.js.org/docs/angular/api/csf
* See https://storybook.js.org/docs/api/csf
* to learn how to use render functions.
*/
export const Primary: Story = {
Expand Down
4 changes: 2 additions & 2 deletions docs/snippets/angular/login-form-with-play-function.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type Story = StoryObj<LoginForm>;
export const EmptyForm: Story = {};

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const FilledForm: Story = {
Expand All @@ -31,7 +31,7 @@ export const FilledForm: Story = {

await userEvent.type(canvas.getByTestId('password'), 'a-random-password');

// See https://storybook.js.org/docs/angular/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
// See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
await userEvent.click(canvas.getByRole('button'));

// 👇 Assert DOM structure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ export default meta;
type Story = StoryObj<MyComponent>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const ExampleWithRole: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);

// See https://storybook.js.org/docs/angular/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
// See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
await userEvent.click(canvas.getByRole('button', { name: / button label/i }));
},
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default meta;
type Story = StoryObj<MyComponent>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const FirstStory: Story = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default meta;
type Story = StoryObj<MyComponent>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const AsyncExample: Story = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default meta;
type Story = StoryObj<MyComponent>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const ExampleAsyncStory: Story = {
Expand All @@ -30,7 +30,7 @@ export const ExampleAsyncStory: Story = {
delay: 100,
});

// See https://storybook.js.org/docs/angular/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
// See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
const Submit = canvas.getByRole('button');
await userEvent.click(Submit);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ export default meta;
type Story = StoryObj<MyComponent>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const ClickExample: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);

// See https://storybook.js.org/docs/angular/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
// See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
await userEvent.click(canvas.getByRole('button'));
},
};
Expand All @@ -31,7 +31,7 @@ export const FireEventExample: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement);

// See https://storybook.js.org/docs/angular/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
// See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
await fireEvent.click(canvas.getByTestId('data-testid'));
},
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default meta;
type Story = StoryObj<MyComponent>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const DelayedStory: Story = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function sleep(ms: number) {
}

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const ExampleChangeEvent: Story = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { MyComponent } from './MyComponent.component';

const meta: Meta<MyComponent> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'Path/To/MyComponent',
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/angular/other-foo-bar-story.ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Foo } from './Foo.component';

const meta: Meta<Foo> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
title: 'OtherFoo/Bar',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default meta;
type Story = StoryObj<RegistrationForm>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const FilledForm: Story = {
Expand All @@ -37,7 +37,7 @@ export const FilledForm: Story = {
await userEvent.type(passwordInput, 'ExamplePassword', {
delay: 100,
});
// See https://storybook.js.org/docs/angular/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
// See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel
const submitButton = canvas.getByRole('button');

await userEvent.click(submitButton);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { MyComponent } from './MyComponent.component';

const meta: Meta<MyComponent> = {
/* 👇 The title prop is optional.
* See https://storybook.js.org/docs/angular/configure/overview#configure-story-loading
* See https://storybook.js.org/docs/configure/overview#configure-story-loading
* to learn how to generate automatic titles
*/
component: MyComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export default meta;
type Story = StoryObj<Form>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const Submitted: Story = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default meta;
type Story = StoryObj<MyComponent>;

/*
* See https://storybook.js.org/docs/angular/writing-stories/play-function#working-with-the-canvas
* See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas
* to learn more about using the canvasElement to query the DOM
*/
export const Submitted: Story = {
Expand Down
Loading

0 comments on commit 8b2fa15

Please sign in to comment.