Skip to content

Commit eadbaea

Browse files
Vinod KumarVinod Kumar
authored andcommitted
Update to docs
1 parent ad3ac46 commit eadbaea

File tree

4 files changed

+11
-13
lines changed

4 files changed

+11
-13
lines changed

docs/how.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,3 @@ There are 2 ways you can achieve Micro Frontend in this ecosystem.
2626
1. You are not loading too many Micro Apps on a page.
2727
2. You don't want to change configurations of Micro App to support Module Federation.
2828
2. **Module Federation**: Multiple separate builds should form a single application. These separate builds should not have dependencies between each other, so they can be developed and deployed individually. Learn more [here](/universal-react-docs/docs/module-federation/).
29-
30-
## Execution flow of generator
31-
32-
Following flow chart explains the workings of generator.
33-
34-
![Execution flow of Universal React generator](/img/universal-react-generator-2x.png)

docs/intro.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ This will help project teams in building applications with great quality, by giv
1919

2020
This will run the universal-react CLI, then you can simply interact with command-prompt to generate 3 different kind of applications in a Monorepo structure.
2121

22+
## Execution flow of generator
23+
24+
Following flow chart explains the workings of generator.
25+
26+
![Execution flow of Universal React generator](/img/universal-react-generator-2x.png)
27+
28+
## CLI walk-through
29+
2230
[![CLI Generator Features by Rakesh Kumar 10](https://s7.gifyu.com/images/Banner018d3b1cbb27ffe53f.jpg)](https://web.microsoftstream.com/video/3b7ca6eb-d0ac-47e9-819b-d3e5e398ba09 "CLI Generator Features by Rakesh Kumar 10")
2331

2432
## Main Tech Dependencies

docs/storybook.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,9 @@ title: Storybook
44
sidebar_label: Storybook
55
---
66

7-
# 📚 Universal React V2 Storybook
7+
In a component driven development ecosystem such as React, a tool like Storybook is essential. It allows developers to build, test component in isolation. This is perfect way to build reusable components. Ideally 80% of development should happen via Storybook this way teams are never blocked because of test data or env issues.
88

9-
## Setup
10-
11-
1. Clone the repo
12-
2. `cd` into the project directory
13-
3. Run `yarn install`
9+
Storybook setup is equipped with important add-ons to test for A11Y as well.
1410

1511
## Commands
1612

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
someSidebar: {
3-
Introduction: ['intro', 'why', 'how', 'features', 'road-map', 'contribution', 'adoption', 'support'],
3+
Introduction: ['intro', 'features', 'why', 'how', 'road-map', 'contribution', 'adoption', 'support'],
44
Features: ['monorepo', 'smart-context', 'design-system', 'loader', 'logger', 'generate-plop', 'module-federation', 'storybook', 'quality-control', 'unit-testing' ],
55
},
66
};

0 commit comments

Comments
 (0)