From 14ee88e0f9615a46f70333f14f68d0d3294160df Mon Sep 17 00:00:00 2001 From: Aleksandra Pleshcheva <46083995+aeksandla@users.noreply.github.com> Date: Thu, 5 Oct 2023 11:01:50 +0300 Subject: [PATCH] fix: update documentation (#611) --- .storybook/stories/documentation/Blocks.mdx | 2 +- .storybook/stories/documentation/Types.mdx | 4 ++-- .../ExtendedFeatures/__stories__/ExtendedFeatures.mdx | 4 ++-- src/blocks/Map/__stories__/Map.mdx | 6 +++--- src/blocks/Media/__stories__/Media.mdx | 8 ++++---- src/blocks/Questions/__stories__/Questions.mdx | 4 ++-- src/blocks/Tabs/__stories__/Tabs.mdx | 6 +++--- src/containers/PageConstructor/README.md | 4 ++-- src/sub-blocks/BackgroundCard/README.md | 4 ++-- src/sub-blocks/BasicCard/README.md | 4 ++-- src/sub-blocks/Content/README.md | 6 +++--- src/sub-blocks/Content/__stories__/Content.mdx | 6 +++--- 12 files changed, 29 insertions(+), 29 deletions(-) diff --git a/.storybook/stories/documentation/Blocks.mdx b/.storybook/stories/documentation/Blocks.mdx index 7ef4809f6..c9c1c8875 100644 --- a/.storybook/stories/documentation/Blocks.mdx +++ b/.storybook/stories/documentation/Blocks.mdx @@ -21,7 +21,7 @@ Each block has the following common properties: bottom?: string }` - block indentation at the top and bottom, default size `l`, examples you can see [here](?path=/story/blocks-cardlayout--with-custom-indents) -_[Common field types](?id=information--common-types&viewMode=docs)_ +_[Common field types](?id=documentation-types&viewMode=docs)_ ## [Banner](?path=/story/blocks-banner--docs&viewMode=docs) diff --git a/.storybook/stories/documentation/Types.mdx b/.storybook/stories/documentation/Types.mdx index 7bef9eaab..c1fc58f9a 100644 --- a/.storybook/stories/documentation/Types.mdx +++ b/.storybook/stories/documentation/Types.mdx @@ -63,13 +63,13 @@ import { Meta } from '@storybook/blocks'; - `color?: string` — Background color - [`image?: ImageObjectProps | ImageObjectProps[] | ImageDeviceProps` — Background image](#ImageObjectProps). If you pass an array, the full-screen mode is automatically turned on. -- `parallax?: bool` — Enable/disable the parallax effect +- `parallax?: boolean` — Enable/disable the parallax effect - [`video?: Video` — Video](#Video) - `youtube?: url` — Link to a video on YouTube - `height?: number` — Block height - `previewImg?: string` - `dataLens?: string |` [DataLens](#DataLens) -- `fullscreen?: bool` — Enabling full-screen mode for image or video +- `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 --- diff --git a/src/blocks/ExtendedFeatures/__stories__/ExtendedFeatures.mdx b/src/blocks/ExtendedFeatures/__stories__/ExtendedFeatures.mdx index f66d4dc23..f7ba0c676 100644 --- a/src/blocks/ExtendedFeatures/__stories__/ExtendedFeatures.mdx +++ b/src/blocks/ExtendedFeatures/__stories__/ExtendedFeatures.mdx @@ -21,8 +21,8 @@ import * as ExtendedFeaturesStories from './ExtendedFeatures.stories.tsx'; - `title?: string` — Item's title - `text?: string` — Item's text (with YFM support) - `additionalInfo?: string` — Gray text (with YFM support) -- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) -- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) +- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs)) +- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs)) - `label?: New | Preview` — Label `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. diff --git a/src/blocks/Map/__stories__/Map.mdx b/src/blocks/Map/__stories__/Map.mdx index ccc306041..54dc37599 100644 --- a/src/blocks/Map/__stories__/Map.mdx +++ b/src/blocks/Map/__stories__/Map.mdx @@ -14,7 +14,7 @@ import * as MapStories from './Map.stories.tsx'; `description: string` — Description. -[`button: Button` — Button](?path=/story/information--common-types&viewMode=docs#button---button) +[`button: Button` — Button](?path=/docs/documentation-types--docs#button) [`map: Map` — Map description](?path=/story/components-map--y-map&viewMode=docs) @@ -28,7 +28,7 @@ import * as MapStories from './Map.stories.tsx'; `additionalInfo?: string` — Gray text (with YFM support) -[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link) +[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link) -[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button) +[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button) diff --git a/src/blocks/Media/__stories__/Media.mdx b/src/blocks/Media/__stories__/Media.mdx index 95352edd4..ce80cf4ee 100644 --- a/src/blocks/Media/__stories__/Media.mdx +++ b/src/blocks/Media/__stories__/Media.mdx @@ -13,9 +13,9 @@ import * as MediaStories from './Media.stories.tsx'; `description: string` — Description. -[`button: Button` — Button](?path=/story/information--common-types&viewMode=docs#button---button) +[`button: Button` — Button](?path=/docs/documentation-types--docs#button) -[`media: Media` — Media description](?path=/story/information--common-types&viewMode=docs#common-types) +[`media: Media` — Media description](?path=/docs/documentation-types--docs) `direction: 'media-content' | 'content-media'` — Relative position of media and content. @@ -25,8 +25,8 @@ import * as MediaStories from './Media.stories.tsx'; `additionalInfo?: string` — Gray text (with YFM support) -[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link) +[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link) -[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button) +[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button) diff --git a/src/blocks/Questions/__stories__/Questions.mdx b/src/blocks/Questions/__stories__/Questions.mdx index 063fbc664..c61f83e65 100644 --- a/src/blocks/Questions/__stories__/Questions.mdx +++ b/src/blocks/Questions/__stories__/Questions.mdx @@ -15,9 +15,9 @@ import * as QuestionsStories from './Questions.stories.tsx'; `additionalInfo?: string` — Gray text (with YFM support) -`links?: Link[]` — An array with link objects (see [Content-blocks](?path=/story/information--common-types&viewMode=docs)) +`links?: Link[]` — An array with link objects (see [Content-blocks](?path=/docs/documentation-types--docs)) -`buttons?: Button[]` — An array with button objects (see [Content-blocks](?path=/story/information--common-types&viewMode=docs)) +`buttons?: Button[]` — An array with button objects (see [Content-blocks](?path=/docs/documentation-types--docs)) `items: QuestionItem[]` diff --git a/src/blocks/Tabs/__stories__/Tabs.mdx b/src/blocks/Tabs/__stories__/Tabs.mdx index db749d048..da3914b31 100644 --- a/src/blocks/Tabs/__stories__/Tabs.mdx +++ b/src/blocks/Tabs/__stories__/Tabs.mdx @@ -27,10 +27,10 @@ import * as TabsStories from './Tabs.stories.tsx'; - `title?: string` — Item's title - `text?: string` — Item's text (with YFM support) - `additionalInfo?: string` — Gray text (with YFM support) -- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) -- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) +- `links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs)) +- `buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs)) - `image?: string | ImageObjectProps` — Image. -- [`media: Media` — Media description](?path=/story/information--common-types&viewMode=docs#media---picvideodatalens) +- [`media: Media` — Media description](?path=/docs/documentation-types#media--imagevideodatalensyoutube) - `caption?: string` — Image caption. diff --git a/src/containers/PageConstructor/README.md b/src/containers/PageConstructor/README.md index 355075024..b1db0a0a7 100644 --- a/src/containers/PageConstructor/README.md +++ b/src/containers/PageConstructor/README.md @@ -11,7 +11,7 @@ PageConstructor container - `color: string` - background color - `animated: true | false` - background animation on load and on scroll - `parallax?: true | false` — enable/disable the parallax effect -- `video?: Video` - [Video](?path=/story/information--common-types#Video) -- `image?: Image` - [ImageObjectProps](?path=/story/information--common-types#ImageObjectProps) +- `video?: Video` - [Video](?path=/docs/documentation-types--docs#Video) +- `image?: Image` - [ImageObjectProps](?path=/docs/documentation-types--docs#ImageObjectProps) - `fullWidthMedia?: true | false` - Media width: Picture or Video to the entire screen width or as per column size. - `height?: number` - height of media diff --git a/src/sub-blocks/BackgroundCard/README.md b/src/sub-blocks/BackgroundCard/README.md index 741cf2d57..a2ebbc5cd 100644 --- a/src/sub-blocks/BackgroundCard/README.md +++ b/src/sub-blocks/BackgroundCard/README.md @@ -12,6 +12,6 @@ `additionalInfo?: string` — Gray text (with YFM support) -`links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) +`links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs)) -`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) +`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs)) diff --git a/src/sub-blocks/BasicCard/README.md b/src/sub-blocks/BasicCard/README.md index f67e17e6e..43dc593c8 100644 --- a/src/sub-blocks/BasicCard/README.md +++ b/src/sub-blocks/BasicCard/README.md @@ -10,8 +10,8 @@ `additionalInfo?: string` — Gray text (with YFM support) -`links?: Link[]` — An array with link objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) +`links?: Link[]` — An array with link objects (see [Content blocks](?path=/docs/documentation-types--docs)) -`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/story/information--common-types&viewMode=docs)) +`buttons?: Button[]` — An array with button objects (see [Content blocks](?path=/docs/documentation-types--docs)) `border: 'shadow' | 'line' | 'none'` — Card border properties (defaults to `'shadow'`). diff --git a/src/sub-blocks/Content/README.md b/src/sub-blocks/Content/README.md index 7063d49c4..2085e1d5e 100644 --- a/src/sub-blocks/Content/README.md +++ b/src/sub-blocks/Content/README.md @@ -1,12 +1,12 @@ -[`title?: Title | string` - title](?path=/story/information--common-types&viewMode=docs#title---block-title) +[`title?: Title | string` - title](?path=/docs/documentation-types--docs#title-block-title) `text?: string` — Text (with YFM support) `additionalInfo?: string` — Gray text (with YFM support) -[`links?: Link[]` — An array with link objects](?path=/story/information--common-types&viewMode=docs#link---link) +[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link) -[`buttons?: Button[]` — An array with button objects](?path=/story/information--common-types&viewMode=docs#button---button) +[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button) `centered?: false | true` - Aligns all content to the center ('false' by default) diff --git a/src/sub-blocks/Content/__stories__/Content.mdx b/src/sub-blocks/Content/__stories__/Content.mdx index a3fae0deb..a940472dc 100644 --- a/src/sub-blocks/Content/__stories__/Content.mdx +++ b/src/sub-blocks/Content/__stories__/Content.mdx @@ -13,9 +13,9 @@ import * as ContentStories from './Content.stories.tsx'; `additionalInfo?: string` — Gray text (with YFM support) -[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link--link) +[`links?: Link[]` — An array with link objects](?path=/docs/documentation-types--docs#link) -[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button--button) +[`buttons?: Button[]` — An array with button objects](?path=/docs/documentation-types--docs#button) `centered?: false | true` - Aligns all content to the center ('false' by default) @@ -32,7 +32,7 @@ import * as ContentStories from './Content.stories.tsx'; - `xl: number` — On a screen wider than 1185px. `list: Array` - An Array of items with icon -- [`icon: string | ImageObjectProps` — Icon](?path=/docs/documentation-types--docs#imageobjectprops--image-property). +- [`icon: string | ImageObjectProps` — Icon](?path=/docs/documentation-types--docs#imageobjectprops---image-property). - `title?: string` — Title. - `text?: string` — Text (with YFM support)