From 381d45aab42b1fd2fda3b700d75083b1772a526c Mon Sep 17 00:00:00 2001 From: Shane Phillips Date: Mon, 2 Jan 2023 15:19:29 -0500 Subject: [PATCH] summary suggestions --- docs/SUMMARY.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 4f7301b..91d3996 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -This command line help you create your React project in a easy and useful structure by creating components and pages in separate folders in order to distinguish between them. +This command line will help you create your React project with a useful structure that is easy to understand. It creates components and pages in separate folders to help distinguish them. The following project structure is used by this command: @@ -66,16 +66,18 @@ src index.js ``` -- As you can see above, the `src` folder is the folder that resides at the root of your React project and under this folder, you will find the `components` folder which contains all the shared components that are used through out the page. The `pages` folder contains the app's pages that can uses some of the shared components above it. +- As you can see above, the `src` folder is the folder that resides at the root of your React project, and under this folder, you will find the `components` folder which contains all the shared components that are used throughout the page. -- In each component you will find `index.jsx` that contains the components `JSX.Element` syntaxes, and `styles.css` that contains the styles for that component. +- The `pages` folder contains the app's pages, which can use some of the shared components above it. -- In each page you will find `index.jsx` that contains the `JSX.Element` syntaxes, and `styles.css` that contains the screen's styles and `functions` folder which will contain the page's specific functions. +- In each component, you will find `index.jsx`. This contains the components `JSX.Element`, for syntaxes, and `styles.css`, which contains the styles for that component. -- Each page can use one of the shared components that are defined in `components` folder, and you can pass the functions to those components hence there is not `functions` folder under a component subfolder. +- In each page you will find `index.jsx` that contains the `JSX.Element` syntaxes, `styles.css` that contains the page's styles, and a `functions` folder which contains the page's specific functions. -- As for the `redux` folder you can see there is `index.js` which contain the redux store, and `actions` and `reducers` folders are next to it so you can find only things that are related to redux in one single place. +- Each page can use one of the shared components that are defined in `components` folder, and you can pass the functions to those components. There is no `functions` folder in a component's subfolder. -- This command line can write code in both JavaScript and TypeScript. By default it will use the used language for your React project and of course you can override the used language using one of its options. +- As for the `redux` folder, you can see there is `index.js` which contains the redux store, and `actions` and `reducers` folders are next to it so that you can find the things that are related to redux in one single place. -- This command line can be customized by a configuration file that you can create in the root of your project (`rhc.config.json`). +- This command line can write code in both JavaScript and TypeScript. By default it will use the language that your React project is written in, and of course you can override the used language using one of the command line's options. + +- This command line can be customized by altering a configuration file that you can create in the root of your project (`rhc.config.json`).