Skip to content

Commit 14ee88e

Browse files
authored
fix: update documentation (#611)
1 parent 2f86fab commit 14ee88e

File tree

12 files changed

+29
-29
lines changed

12 files changed

+29
-29
lines changed

.storybook/stories/documentation/Blocks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Each block has the following common properties:
2121
bottom?: string
2222
}` - block indentation at the top and bottom, default size `l`, examples you can see [here](?path=/story/blocks-cardlayout--with-custom-indents)
2323

24-
_[Common field types](?id=information--common-types&viewMode=docs)_
24+
_[Common field types](?id=documentation-types&viewMode=docs)_
2525

2626
## [Banner](?path=/story/blocks-banner--docs&viewMode=docs)
2727

.storybook/stories/documentation/Types.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ import { Meta } from '@storybook/blocks';
6363

6464
- `color?: string` — Background color
6565
- [`image?: ImageObjectProps | ImageObjectProps[] | ImageDeviceProps` — Background image](#ImageObjectProps). If you pass an array, the full-screen mode is automatically turned on.
66-
- `parallax?: bool` — Enable/disable the parallax effect
66+
- `parallax?: boolean` — Enable/disable the parallax effect
6767
- [`video?: Video` — Video](#Video)
6868
- `youtube?: url` — Link to a video on YouTube
6969
- `height?: number` — Block height
7070
- `previewImg?: string`
7171
- `dataLens?: string |` [DataLens](#DataLens)
72-
- `fullscreen?: bool` — Enabling full-screen mode for image or video
72+
- `fullscreen?: boolean` — Enabling full-screen mode for image or video. Default true - for multiple images, false - for single image, video. It doesn't work with dataLens and youtube
7373

7474
---
7575

src/blocks/ExtendedFeatures/__stories__/ExtendedFeatures.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ import * as ExtendedFeaturesStories from './ExtendedFeatures.stories.tsx';
2121
- `title?: string` — Item's title
2222
- `text?: string` — Item's text (with YFM support)
2323
- `additionalInfo?: string` — Gray text (with YFM support)
24-
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
25-
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
24+
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))
25+
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))
2626
- `label?: New | Preview` — Label
2727

2828
`colSizes?: Object` — Sizes of a single card in columns for different screen sizes, the value ranges from 1 to 12 columns. If 12 columns, a single card takes up the entire width of the screen.

src/blocks/Map/__stories__/Map.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import * as MapStories from './Map.stories.tsx';
1414

1515
`description: string` — Description.
1616

17-
[`button: Button` — Button](?path=/story/information--common-types&viewMode=docs#button---button)
17+
[`button: Button` — Button](?path=/docs/documentation-types--docs#button)
1818

1919
[`map: Map` — Map description](?path=/story/components-map--y-map&viewMode=docs)
2020

@@ -28,7 +28,7 @@ import * as MapStories from './Map.stories.tsx';
2828

2929
`additionalInfo?: string` — Gray text (with YFM support)
3030

31-
[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link)
31+
[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link)
3232

33-
[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button)
33+
[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button)
3434
</StoryTemplate>

src/blocks/Media/__stories__/Media.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import * as MediaStories from './Media.stories.tsx';
1313

1414
`description: string` — Description.
1515

16-
[`button: Button` — Button](?path=/story/information--common-types&viewMode=docs#button---button)
16+
[`button: Button` — Button](?path=/docs/documentation-types--docs#button)
1717

18-
[`media: Media` — Media description](?path=/story/information--common-types&viewMode=docs#common-types)
18+
[`media: Media` — Media description](?path=/docs/documentation-types--docs)
1919

2020
`direction: 'media-content' | 'content-media'` — Relative position of media and content.
2121

@@ -25,8 +25,8 @@ import * as MediaStories from './Media.stories.tsx';
2525

2626
`additionalInfo?: string` — Gray text (with YFM support)
2727

28-
[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link)
28+
[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link)
2929

30-
[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button)
30+
[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button)
3131

3232
</StoryTemplate>

src/blocks/Questions/__stories__/Questions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ import * as QuestionsStories from './Questions.stories.tsx';
1515

1616
`additionalInfo?: string` — Gray text (with YFM support)
1717

18-
`links?: Link[]` — An array with link objects (see [Content-blocks](?path=/story/information--common-types&viewMode=docs))
18+
`links?: Link[]` — An array with link objects (see [Content-blocks](?path=/docs/documentation-types--docs))
1919

20-
`buttons?: Button[]` — An array with button objects (see [Content-blocks](?path=/story/information--common-types&viewMode=docs))
20+
`buttons?: Button[]` — An array with button objects (see [Content-blocks](?path=/docs/documentation-types--docs))
2121

2222
`items: QuestionItem[]`
2323

src/blocks/Tabs/__stories__/Tabs.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ import * as TabsStories from './Tabs.stories.tsx';
2727
- `title?: string` — Item's title
2828
- `text?: string` — Item's text (with YFM support)
2929
- `additionalInfo?: string` — Gray text (with YFM support)
30-
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
31-
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
30+
- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))
31+
- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))
3232
- `image?: string | ImageObjectProps` — Image.
33-
- [`media: Media` — Media description](?path=/story/information--common-types&viewMode=docs#media---picvideodatalens)
33+
- [`media: Media` — Media description](?path=/docs/documentation-types#media--imagevideodatalensyoutube)
3434
- `caption?: string` — Image caption.
3535

3636
</StoryTemplate>

src/containers/PageConstructor/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ PageConstructor container
1111
- `color: string` - background color
1212
- `animated: true | false` - background animation on load and on scroll
1313
- `parallax?: true | false` — enable/disable the parallax effect
14-
- `video?: Video` - [Video](?path=/story/information--common-types#Video)
15-
- `image?: Image` - [ImageObjectProps](?path=/story/information--common-types#ImageObjectProps)
14+
- `video?: Video` - [Video](?path=/docs/documentation-types--docs#Video)
15+
- `image?: Image` - [ImageObjectProps](?path=/docs/documentation-types--docs#ImageObjectProps)
1616
- `fullWidthMedia?: true | false` - Media width: Picture or Video to the entire screen width or as per column size.
1717
- `height?: number` - height of media

src/sub-blocks/BackgroundCard/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@
1212

1313
`additionalInfo?: string` — Gray text (with YFM support)
1414

15-
`links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
15+
`links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))
1616

17-
`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
17+
`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))

src/sub-blocks/BasicCard/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
`additionalInfo?: string` — Gray text (with YFM support)
1212

13-
`links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
13+
`links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs))
1414

15-
`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs))
15+
`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs))
1616

1717
`border: 'shadow' | 'line' | 'none'` — Card border properties (defaults to `'shadow'`).

0 commit comments

Comments
 (0)