Skip to content

Commit 079ca2e

Browse files
amyrlamnate770
authored andcommitted
Edits to Getting Started
- Copy edits for consistency - Remove <br>'s for readability Should all headers be Title Case? I see `Creating an App` but `Installing A Dependency`. I tend to use https://titlecaseconverter.com/, thoughts?
1 parent 9430dbb commit 079ca2e

File tree

6 files changed

+25
-41
lines changed

6 files changed

+25
-41
lines changed

docusaurus/docs/available-scripts.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,19 @@ In the project directory, you can run:
88

99
## `npm start`
1010

11-
Runs the app in the development mode.<br>
12-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
11+
Runs the app in the development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
1312

14-
The page will reload if you make edits.<br>
15-
You will also see any lint errors in the console.
13+
The page will reload if you make edits. You will also see any lint errors in the console.
1614

1715
## `npm test`
1816

19-
Launches the test runner in the interactive watch mode.<br>
20-
See the section about [running tests](/docs/running-tests) for more information.
17+
Launches the test runner in the interactive watch mode. See the section about [running tests](/docs/running-tests) for more information.
2118

2219
## `npm run build`
2320

24-
Builds the app for production to the `build` folder.<br>
25-
It correctly bundles React in production mode and optimizes the build for the best performance.
21+
Builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance.
2622

27-
The build is minified and the filenames include the hashes.<br>
28-
Your app is ready to be deployed!
23+
The build is minified and the filenames include the hashes. Your app is ready to be deployed!
2924

3025
See the section about [deployment](/docs/deployment) for more information.
3126

docusaurus/docs/documentation-intro.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
id: documentation-intro
3-
title: Welcome To The Documentation
3+
title: About The Docs
44
sidebar_label: About The Docs
55
---
66

7-
Please navigate via the table of content for finding what you are looking for.
7+
Welcome to the documentation! Please navigate via the table of contents to find what you are looking for.
88

99
## Something Missing?
1010

docusaurus/docs/folder-structure.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,8 @@ For the project to build, **these files must exist with exact filenames**:
2929

3030
You can delete or rename the other files.
3131

32-
You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack.<br>
33-
You need to **put any JS and CSS files inside `src`**, otherwise Webpack won’t see them.
32+
You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack. You need to **put any JS and CSS files inside `src`**, otherwise Webpack won’t see them.
3433

35-
Only files inside `public` can be used from `public/index.html`.<br>
36-
Read instructions below for using assets from JavaScript and HTML.
34+
Only files inside `public` can be used from `public/index.html`. Read instructions below for using assets from JavaScript and HTML.
3735

38-
You can, however, create more top-level directories.<br>
39-
They will not be included in the production build so you can use them for things like documentation.
36+
You can, however, create more top-level directories. They will not be included in the production build so you can use them for things like documentation.

docusaurus/docs/getting-started.md

+10-16
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ npm start
1616

1717
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
1818

19-
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.<br>
19+
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.
20+
2021
When you’re ready to deploy to production, create a minified bundle with `npm run build`.
2122

2223
<p align='center'>
@@ -25,8 +26,7 @@ When you’re ready to deploy to production, create a minified bundle with `npm
2526

2627
### Get Started Immediately
2728

28-
You **don’t** need to install or configure tools like Webpack or Babel.<br>
29-
They are preconfigured and hidden so that you can focus on the code.
29+
You **don’t** need to install or configure tools like Webpack or Babel. They are preconfigured and hidden so that you can focus on the code.
3030

3131
Just create a project, and you’re good to go.
3232

@@ -62,8 +62,7 @@ _`yarn create` is available in Yarn 0.25+_
6262

6363
## Output
6464

65-
Running either of these commands will create a directory called `my-app` inside the current folder.<br>
66-
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
65+
Running amy of these commands will create a directory called `my-app` inside the current folder. Inside that directory, it will generate the initial project structure and install the transitive dependencies:
6766

6867
```
6968
my-app
@@ -85,8 +84,7 @@ my-app
8584
└── serviceWorker.js
8685
```
8786

88-
No configuration or complicated folder structures, just the files you need to build your app.<br>
89-
Once the installation is done, you can open your project folder:
87+
No configuration or complicated folder structures, just the files you need to build your app. Once the installation is done, you can open your project folder:
9088

9189
```sh
9290
cd my-app
@@ -98,27 +96,23 @@ Inside the newly created project, you can run some built-in commands:
9896

9997
### `npm start` or `yarn start`
10098

101-
Runs the app in development mode.<br>
102-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
99+
Runs the app in development mode. Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
103100

104-
The page will automatically reload if you make changes to the code.<br>
105-
You will see the build errors and lint warnings in the console.
101+
The page will automatically reload if you make changes to the code. You will see the build errors and lint warnings in the console.
106102

107103
<p align='center'>
108104
<img src='https://cdn.rawgit.com/marionebl/create-react-app/9f62826/screencast-error.svg' width='600' alt='Build errors'>
109105
</p>
110106

111107
### `npm test` or `yarn test`
112108

113-
Runs the test watcher in an interactive mode.<br>
114-
By default, runs tests related to files changed since the last commit.
109+
Runs the test watcher in an interactive mode. By default, runs tests related to files changed since the last commit.
115110

116-
[Read more about testing.](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
111+
[Read more about testing](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests).
117112

118113
### `npm run build` or `yarn build`
119114

120-
Builds the app for production to the `build` folder.<br>
121-
It correctly bundles React in production mode and optimizes the build for the best performance.
115+
Builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance.
122116

123117
The build is minified and the filenames include the hashes.
124118

docusaurus/docs/supported-language-features.md docusaurus/docs/supported-browsers-features.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
---
22
id: supported-browsers-features
33
title: Supported Browsers And Features
4-
sidebar_label: Browsers & Features
4+
sidebar_label: Supported Browsers And Features
55
---
66

77
## Supported Browsers
88

9-
By default, the generated project supports all modern browsers.<br>
10-
Support for Internet Explorer 9, 10, and 11 requires [polyfills](https://github.com/facebook/create-react-app/blob/master/packages/react-app-polyfill/README.md).
9+
By default, the generated project supports all modern browsers. Support for Internet Explorer 9, 10, and 11 requires [polyfills](https://github.com/facebook/create-react-app/blob/master/packages/react-app-polyfill/README.md).
1110

1211
## Supported Language Features
1312

14-
This project supports a superset of the latest JavaScript standard.<br>
15-
In addition to [ES6](https://github.com/lukehoban/es6features) syntax features, it also supports:
13+
This project supports a superset of the latest JavaScript standard. In addition to [ES6](https://github.com/lukehoban/es6features) syntax features, it also supports:
1614

1715
- [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016).
1816
- [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017).

docusaurus/website/i18n/en.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
"title": "Developing Components In Isolation"
6969
},
7070
"documentation-intro": {
71-
"title": "Welcome To The Documentation",
71+
"title": "About The Docs",
7272
"sidebar_label": "About The Docs"
7373
},
7474
"fetching-data-with-ajax-requests": {
@@ -114,7 +114,7 @@
114114
},
115115
"supported-browsers-features": {
116116
"title": "Supported Browsers And Features",
117-
"sidebar_label": "Browsers & Features"
117+
"sidebar_label": "Supported Browsers And Features"
118118
},
119119
"title-and-meta-tags": {
120120
"title": "Title And Meta Tags",

0 commit comments

Comments
 (0)