Skip to content

Commit c5c7893

Browse files
authored
docs: add information about peer dependencies, and fix broken link on storybook (#605)
1 parent f6b95f5 commit c5c7893

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,18 @@
66

77
When creating pages, component-based approach is used: a page is built using a set of ready-made blocks that can be placed in any order. Each block has a certain type and set of input data parameters.
88

9-
For the format of input data and list of available blocks, see the [documentation](https://preview.yandexcloud.dev/page-constructor/?path=/story/information--blocks).
9+
For the format of input data and list of available blocks, see the [documentation](https://preview.yandexcloud.dev/page-constructor/?path=/docs/documentation-blocks--docs).
1010

1111
## Install
1212

1313
```shell
1414
npm install @gravity-ui/page-constructor
1515
```
1616

17+
## Required dependencies
18+
19+
Please note that to start using the package, your project must also have the following installed: `@doc-tools/transform`, `@gravity-ui/uikit`, `react`. Check out the `peerDependencies` section of `package.json` for accurate information.
20+
1721
### Getting started
1822

1923
The page constructor is imported as a React component. To make sure it runs properly, wrap it in `PageConstructorProvider`:

0 commit comments

Comments
 (0)