Updated Docs:

1. Fixed logo size on intro page 2. Added content for adoption guide. 3. Added road map items. 4. deleted suppor page.
pagesource · Jun 7, 2022 · 47120cb · 47120cb
1 parent b9307c5
commit 47120cb
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 39 deletions.
diff --git a/docs/adoption.md b/docs/adoption.md
@@ -17,3 +17,21 @@ Universal React accelerator can be adopted into your projects in multiple ways.
 
 1. **Out of the box adoption**: You can use `npx create-universal-react`to setup your project, if you are completely aligned with [Technology choices](/universal-react-docs/docs/features/). You can make necessary tweaks and adjust these choices post initial setup.
 2. **Clone the Generator**: You can clone the generator, customize it as per your organization needs and publish it to artifactory.
+
+## How Universal React team can support adoption. 
+
+1. RFP support.
+2. Client pitches.
+3. Feature enhancements and customization. 
+4. Continuous bug fixes and releases. 
+5. Detailed walk through sessions. 
+
+We have a [future road map](/universal-react-docs/docs/road-map/) to continuously evolve this tool and make it even better. 
+
+## How much time you save when using this accelerator?
+
+There are two ways of looking at potential effort saves:
+
+1. It helps you save the most important time at the start of the project, by providing a dependable dev ecosystem. A rough estimate of time saved for off the self (`npx create-universal-react`) implementation is 2 Weeks. Since we have a lot of best practices and optional features baked-in. Owing to its evolving nature, it continues to add value throughout the project life cycle. Therefore actual effort saved is much more.
+
+2. If you are looking to build a similar CLI generator for customized on-prem uses, adopting and publishing this tool into on-prem artifactory can save at least 2 months. 
diff --git a/docs/features.md b/docs/features.md
@@ -5,26 +5,26 @@ title: Features Summary
 
 This accelerator is an highly opinionated collection of tools and best practices. It is possible that you have a different take on some of these choices. Feel free to enhance your project post initial setup or clone of this generator to suit your needs. 
 
-## Ecosystem of this reference architecture generator  🎉
+## Ecosystem of this generator 🎉
 
 | Feature | Uses | Configurability | Optional |
 | ------ | ------ |  ------ | ------|
 | Monorepo development environment | [Turborepo](https://turborepo.org/) | No | No|
 | SSR & SSG | [Next.js](https://nextjs.org/) | No | No
-| Micro Frontend | [Module Federation](https://webpack.js.org/concepts/module-federation/) | No | No
-| Component Scaffolding | [Generate-Plop](https://github.com/pagesource/component-generator) | No | Yes
-| State Management | [Smart-Context](https://www.npmjs.com/package/smart-context) | No | No
-| Remote Data | [React Query](https://react-query.tanstack.com/) | No | No
-| Unit Testing | [Jest](https://jestjs.io/) & [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) | No | No
+| Micro Frontend | [Module Federation](https://webpack.js.org/concepts/module-federation/) | Yes | Yes
+| Component Scaffolding | [Generate-Plop](https://github.com/pagesource/component-generator) | Yes | Yes
+| State Management | [Smart-Context](https://www.npmjs.com/package/smart-context) | Yes | No
+| Remote Data | [React Query](https://react-query.tanstack.com/) | Yes | No
+| Unit Testing | [Jest](https://jestjs.io/) & [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) | Yes | No
 | E2E Testing automation | [Test Cafe](https://testcafe.io/) | Yes | Yes
-| Theme & Styling | [Stitches](https://stitches.dev/) | No | No
-| Generic Component Library | [Next UI](https://nextui.org/) | No | No
-| Component Browsing | [Storybook](https://storybook.js.org/). | No | No
-| Git Hooks | [Husky](https://typicode.github.io/husky/#/) | No | No
-| PWA | [Workbox](https://developer.chrome.com/docs/workbox/)  | No | Yes
-|Authoring | [Markdown-to-JSX](https://www.npmjs.com/package/markdown-to-jsx) | No | No
+| Theme & Styling | [Stitches](https://stitches.dev/) | Yes | No
+| Generic Component Library | [Next UI](https://nextui.org/) | Yes | Yes
+| Component Dev | [Storybook](https://storybook.js.org/). | Yes | No
+| Git Hooks | [Husky](https://typicode.github.io/husky/#/) | Yes | No
+| PWA | [Workbox](https://developer.chrome.com/docs/workbox/)  | Yes | Yes
+|Authoring | [Markdown-to-JSX](https://www.npmjs.com/package/markdown-to-jsx) | Yes | Yes
 | Scaffolding | [Atomic Design](https://bradfrost.com/blog/post/atomic-web-design/) | No | No
-| Typesafe | [TypeScript](https://www.typescriptlang.org/). | No | No
-|Mocking | [GraphQl](https://graphql.org/) & REST APIs | Yes | No
-|Localization |NA | No| No
-|Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No 
+| Typesafe | [TypeScript](https://www.typescriptlang.org/). | Yes | No
+| Mocking | [GraphQl](https://graphql.org/) & REST APIs | Yes | Yes
+| Localization and Logging |NA | Yes | No
+| Code quality and formatting | Eslint, StyleLint and Prettier | Yes | No 
diff --git a/docs/intro.md b/docs/intro.md
@@ -5,6 +5,8 @@ title: Universal React
 
 [![Forks](https://img.shields.io/github/forks/pagesource/universal-react-v2)](https://img.shields.io/github/forks/pagesource/universal-react-v2) [![Stars](https://img.shields.io/github/stars/pagesource/universal-react-v2)](https://img.shields.io/github/stars/pagesource/universal-react-v2) [![License](https://img.shields.io/github/license/pagesource/universal-react-v2)](https://img.shields.io/github/license/pagesource/universal-react-v2)
 
+![UniversalReact](/img/logo.svg)
+
 An accelerator for setting-up scalable frontend architecture with React and Next.js.
 
 This accelerator is a command line tool for generating SSR, SSG & Micro-App type of applications. This enables you to setup a full-fledged Micro Frontend development ecosystem with essential tooling for great dev experience and delivery quality.

diff --git a/docs/road-map.md b/docs/road-map.md
@@ -3,3 +3,14 @@ id: road-map
 title: Future road map
 ---
 
+There are many additional capabilities we are looking forward to add. Some of those are listed here in order of priority. We are open to take additional feature requests from out community through [issus page](https://github.com/pagesource/universal-react-v2/issues).  
+
+1. Configuration Management. 
+2. CI/CD Pipelines Templates. 
+3. Telemetry
+4. Industry Specific Solutions 
+5. Analytics  
+6. Redis integration with SSR arch type. 
+7. Edge Computing. 
+
+
diff --git a/docs/support.md b/docs/support.md
diff --git a/docs/why.md b/docs/why.md
@@ -18,24 +18,24 @@ title: Why you need Universal React?
 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.
 
 ## Industry Comparison 
-|  | Create react app | Create Next app | Universal react app |
+|  | Create React App | Create Next App | Universal React App |
 | ------ | ------ |  ------ | ------ |
 | SSR, SSG | No | Yes | Yes
-| MicroApp | No | No | Yes
-| Configurability | Not much room for configuration | Almost everything is configurable | Almost everything is configurable
-| Monorepo support | Not out of the box | Not out of the box | Yes, comes with turborepo setup
+| MicroApp | Yes | No | Yes
+| Configurability | Low | High | Very High
+| Monorepo setup | No | No | Yes, with Turborepo
 | Typescript | Yes | Yes | Yes
-| Inbuilt Unit Testing setup | No | No | Yes
-| Inbuilt Storybook setup | No | No | Yes
-| Integrated design system | No | No | Yes, using Nextui
-| Inbuilt Loader | No | No | Yes 
-| Smart Context | No | No | Yes
-| Integrated browser & server logger | No | No | Yes
-| Integrated Component generator | No | No | Yes, using generate-plop
-| Module Federation base setup | No | No | Yes
-|Quality control cofiguration setup | No | No | Yes
-| E2E automation | No | No | Yes, using Test Cafe
-| PWA | No | No | Yes, using workbox
+| Unit Testing setup | Yes | Yes | Yes
+| Inbuilt Storybook | No | No | Yes
+| Design system | No | No | Yes
+| Micro App Loader | No | No | Yes 
+| State Management | No | No | Yes, with Smart Context
+| Browser & Server logger | No | No | Yes
+| Component generator | No | No | Yes, with Generate Plop
+| Module Federation | No | No | Yes
+| Quality control config | No | No | Yes
+| E2E automation | No | No | Yes, with Test Cafe
+| PWA | No | No | Yes, with Workbox
 
 ## Impact and Efficiency 
 

diff --git a/sidebars.js b/sidebars.js
@@ -1,6 +1,6 @@
 module.exports = {
   someSidebar: {
-    Introduction: ['intro', 'features', 'why', 'how', 'road-map', 'contribution', 'adoption', 'support'],
+    Introduction: ['intro', 'features', 'why', 'how', 'road-map', 'contribution', 'adoption'],
     Features: ['monorepo', 'smart-context', 'design-system', 'atomic-design', 'loader', 'logger', 'generate-plop', 'module-federation', 'storybook', 'quality-control', 'unit-testing' ],
   },
 };
diff --git a/src/css/custom.css b/src/css/custom.css
@@ -22,4 +22,6 @@
   display: block;
   margin: 0 calc(-1 * var(--ifm-pre-padding));
   padding: 0 var(--ifm-pre-padding);
-}
+}
+
+img[alt=UniversalReact] { width: 150px; }