Skip to content

Commit ad3ac46

Browse files
Vinod KumarVinod Kumar
authored andcommitted
Updated Documentation for Intro & Why and How
1 parent b6ee947 commit ad3ac46

File tree

3 files changed

+15
-16
lines changed

3 files changed

+15
-16
lines changed

docs/how.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,30 @@ title: How it works?
55

66
There are 2 Key Pillars of Universal React.
77

8-
## 1. Accelerate React Development by instant initial setup
8+
## 1. Instant initial setup
99

10-
React developers can run `npx create-universal-react` generator for setting up Micro Frontend and SPA architecture with essential tooling instantly.
11-
## 2. Continuous Improvement and Support via addition of optional features
10+
React developers can run `npx create-universal-react` generator for setting up Micro Frontend and/or SPA architecture with essential tooling instantly.
11+
## 2. On-demand addition of optional features
1212

13-
React developers can run `npx create-universal-react` generator again for adding on-demand optional features and projects to evolving applications generated with Universal React.
13+
React developers can continuously improve their project by running `npx create-universal-react` generator again for adding optional features like mocking, end-to-end testing or even new projects to their evolving applications.
1414

15-
## Execution flow of generator
16-
17-
Following flow chart explains the workings of generator.
18-
19-
![Execution flow of Universal React generator](/img/universal-react-generator-2x.png)
20-
21-
## Possible Architecture Overview
15+
## Architecture Overview
2216

23-
Using this generator flow you can setup and evolve a project into following Architecture types.
17+
Using this generator you can setup and evolve a project into a combination of following architecture types.
2418

2519
![Architecture Types with Universal React generator](/img/universal-react-arch-types-2x.png)
2620

21+
### How does Universal React achieve Micro Frontend?
22+
2723
There are 2 ways you can achieve Micro Frontend in this ecosystem.
2824

29-
1. Micro-App Loader: A small NPM package to load any React micro app or Web Component into a given container. This approach is ideal when:
25+
1. **Micro-App Loader**: A small NPM package to load any React micro app or Web Component into a given container. This approach is ideal when:
3026
1. You are not loading too many Micro Apps on a page.
3127
2. You don't want to change configurations of Micro App to support Module Federation.
32-
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/).
28+
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/).
3329

30+
## Execution flow of generator
3431

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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ This will run the universal-react CLI, then you can simply interact with command
2828
3. Turborepo
2929

3030
### Uses Prerequisites
31+
3132
1. Node >= 14.17.6
3233
2. NPM >= 7.0.0
3334
3. Python Latest Version

docs/why.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,5 @@ title: Why you need this generator?
1515
3. Attention to Developer experience for great productivity.
1616
4. Preservation and replication of low-level best practices.
1717

18-
## How does Universal React addresses above concerns?
19-
2018
With **Reuse, Replicate and Reduce** philosophy at its core Universal React is an accelerator to generate SSR, SSG or Micro-Apps with essential tooling to enable great dev experience and solution quality.
2119

0 commit comments

Comments
 (0)