Skip to content

docs: update storybook #662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,7 @@ You can find our documentation under the following links:

- [Stable Release Documentation](https://sap.github.io/ui5-webcomponents-react/)
- [Next Release Documentation](https://sap.github.io/ui5-webcomponents-react/master/)

## Migration Guide

Each new major version of this project might contain breaking changes which require you to change coding in your project.
In order to help you with those tasks, we have prepared a [Migration Guide](https://sap.github.io/ui5-webcomponents-react/master/?path=/docs/migration-guide--page).
- [Migration Guide](https://sap.github.io/ui5-webcomponents-react/?path=/docs/migration-guide--page)

## Package Overview

Expand Down Expand Up @@ -85,9 +81,14 @@ npm install @ui5/webcomponents-react --save

<!-- *********************************************************************** -->

<a name="configuration"></a>
## Getting Started

### Tutorial

## Configuration
You are new to UI5 Web Components for React and don't know where to start?<br />
Then take a look at our [Tutorial Mission](https://developers.sap.com/mission.react-spa.html) at “SAP Developers”!
There you get a first glimpse at how easy it is to create an Application with UI5 Web Components for React.<br />
In about an hour you will create a business dashboard from scratch and get familiar with some React basics in case you don't know them already.

### Creating a new React app

Expand Down
9 changes: 7 additions & 2 deletions docs/1-Welcome.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ import { Button } from '@ui5/webcomponents-react/lib/Button';

[Open Github Project](https://github.com/SAP/ui5-webcomponents-react)

## Description

UI5 Web Components for React is a Fiori3 compliant React library built on top of the UI5 Web Components.
With the help of UI5 Web Components for React, you can use UI5 Web Components as if they were native React components.
In addition to that, UI5 Web Components for React is providing complex components and layouts on top of the UI5 Web Components.
Expand All @@ -28,6 +26,13 @@ In addition to that, UI5 Web Components for React is providing complex component

## Getting Started

### Tutorial

You are new to UI5 Web Components for React and don't know where to start?<br />
Then take a look at our [Tutorial Mission](https://developers.sap.com/mission.react-spa.html) at “SAP Developers”!
There you get a first glimpse at how easy it is to create an Application with UI5 Web Components for React.<br />
In about an hour you will create a business dashboard from scratch and get familiar with some React basics in case you don't know them already.

### Creating a new React app

You can create a new react app by using [create-react-app](https://facebook.github.io/create-react-app/) with our template.
Expand Down
18 changes: 9 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@
"deploy:storybook": "lerna run build:i18n && storybook-to-ghpages --ci"
},
"dependencies": {
"@storybook/addon-actions": "6.0.4",
"@storybook/addon-controls": "6.0.4",
"@storybook/addon-docs": "6.0.4",
"@storybook/addon-toolbars": "6.0.4",
"@storybook/addons": "6.0.4",
"@storybook/cli": "6.0.4",
"@storybook/react": "6.0.4",
"@storybook/theming": "6.0.4",
"@storybook/addon-actions": "6.0.13",
"@storybook/addon-controls": "6.0.13",
"@storybook/addon-docs": "6.0.13",
"@storybook/addon-toolbars": "6.0.13",
"@storybook/addons": "6.0.13",
"@storybook/cli": "6.0.13",
"@storybook/react": "6.0.13",
"@storybook/theming": "6.0.13",
"@ui5/webcomponents": "1.0.0-rc.8",
"@ui5/webcomponents-fiori": "1.0.0-rc.8",
"@ui5/webcomponents-icons": "1.0.0-rc.8",
Expand All @@ -50,7 +50,7 @@
"@rollup/plugin-json": "^4.0.3",
"@rollup/plugin-node-resolve": "^8.4.0",
"@rollup/plugin-replace": "^2.3.2",
"@storybook/storybook-deployer": "^2.8.5",
"@storybook/storybook-deployer": "^2.8.6",
"@testing-library/jest-dom": "^5.11.2",
"@testing-library/react": "^10.4.7",
"@types/enzyme": "^3.10.5",
Expand Down
Loading