Skip to content

Commit

Permalink
Merge pull request #5400 from amyrlam/amy/tweaks
Browse files Browse the repository at this point in the history
Tweaks
  • Loading branch information
selbekk authored Oct 11, 2018
2 parents 8e5f065 + 6235d57 commit 9d79482
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 47 deletions.
15 changes: 5 additions & 10 deletions docusaurus/docs/available-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,19 @@ In the project directory, you can run:

## `npm start`

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

The page will reload if you make edits.<br>
You will also see any lint errors in the console.
The page will reload if you make edits. You will also see any lint errors in the console.

## `npm test`

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

## `npm run build`

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.
Builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!
The build is minified and the filenames include the hashes. Your app is ready to be deployed!

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

Expand Down
4 changes: 2 additions & 2 deletions docusaurus/docs/documentation-intro.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: documentation-intro
title: Welcome To The Documentation
title: About The Docs
sidebar_label: About The Docs
---

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

## Something Missing?

Expand Down
9 changes: 3 additions & 6 deletions docusaurus/docs/folder-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,8 @@ For the project to build, **these files must exist with exact filenames**:

You can delete or rename the other files.

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

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

You can, however, create more top-level directories.<br>
They will not be included in the production build so you can use them for things like documentation.
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.
26 changes: 10 additions & 16 deletions docusaurus/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ npm start

_([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))_

Then open [http://localhost:3000/](http://localhost:3000/) to see your app.<br>
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.

When you’re ready to deploy to production, create a minified bundle with `npm run build`.

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

### Get Started Immediately

You **don’t** need to install or configure tools like Webpack or Babel.<br>
They are preconfigured and hidden so that you can focus on the code.
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.

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

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

## Output

Running either of these commands will create a directory called `my-app` inside the current folder.<br>
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
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:

```
my-app
Expand All @@ -85,8 +84,7 @@ my-app
└── registerServiceWorker.js
```

No configuration or complicated folder structures, just the files you need to build your app.<br>
Once the installation is done, you can open your project folder:
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:

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

### `npm start` or `yarn start`

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

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

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

### `npm test` or `yarn test`

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

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

### `npm run build` or `yarn build`

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.
Builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
---
id: supported-browsers-features
title: Supported Browsers And Features
sidebar_label: Browsers & Features
sidebar_label: Supported Browsers And Features
---

## Supported Browsers

By default, the generated project supports all modern browsers.<br>
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).
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).

## Supported Language Features

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

- [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016).
- [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017).
Expand Down
6 changes: 3 additions & 3 deletions docusaurus/website/core/Footer.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ class Footer extends React.Component {
</a>
<div>
<h5>Docs</h5>
<a href={this.docUrl('documentation-intro', this.props.language)}>
About The Docs
</a>
<a href={this.docUrl('getting-started', this.props.language)}>
Getting Started
</a>
<a href={this.docUrl('documentation-intro', this.props.language)}>
Documentation
</a>
</div>
<div>
<h5>Community</h5>
Expand Down
6 changes: 3 additions & 3 deletions docusaurus/website/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"title": "Developing Components In Isolation"
},
"documentation-intro": {
"title": "Welcome To The Documentation",
"title": "About The Docs",
"sidebar_label": "About The Docs"
},
"fetching-data-with-ajax-requests": {
Expand Down Expand Up @@ -114,7 +114,7 @@
},
"supported-browsers-features": {
"title": "Supported Browsers And Features",
"sidebar_label": "Browsers & Features"
"sidebar_label": "Supported Browsers And Features"
},
"title-and-meta-tags": {
"title": "Title And Meta Tags",
Expand All @@ -139,7 +139,7 @@
}
},
"links": {
"Getting started": "Getting started",
"Getting Started": "Getting Started",
"Help": "Help",
"GitHub": "GitHub"
},
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/website/pages/en/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ class HomeSplash extends React.Component {
<ProjectTitle />
<PromoSection>
<Button href={docUrl('getting-started', language)}>
Get started
Getting Started
</Button>
<Button href={docUrl('documentation-intro', language)}>Documentation</Button>
</PromoSection>
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/website/siteConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ const siteConfig = {

// For no header links in the top nav bar -> headerLinks: [],
headerLinks: [
{ doc: 'getting-started', label: 'Getting started' },
{ doc: 'getting-started', label: 'Getting Started' },
{ href: 'https://reactjs.org/community/support.html', label: 'Help' },
{
href: 'https://www.github.com/facebook/create-react-app',
Expand Down

0 comments on commit 9d79482

Please sign in to comment.