Skip to content

Commit 0febe26

Browse files
gaearongaearon
committed
doc tweaks
1 parent a840d56 commit 0febe26

22 files changed

+82
-63
lines changed

‎docusaurus/docs/adding-a-css-modules-stylesheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: adding-a-css-modules-stylesheet
3-
title: Adding A CSS Modules Stylesheet
3+
title: Adding a CSS Modules Stylesheet
44
sidebar_label: Adding CSS Modules
55
---
66

‎docusaurus/docs/adding-a-router.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: adding-a-router
3-
title: Adding A Router
3+
title: Adding a Router
44
---
55

66
Create React App doesn't prescribe a specific routing solution, but [React Router](https://reacttraining.com/react-router/web/) is the most popular one.

‎docusaurus/docs/adding-a-sass-stylesheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: adding-a-sass-stylesheet
3-
title: Adding A Sass Stylesheet
3+
title: Adding a Sass Stylesheet
44
sidebar_label: Adding Sass Stylesheets
55
---
66

‎docusaurus/docs/adding-a-stylesheet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: adding-a-stylesheet
3-
title: Adding A Stylesheet
3+
title: Adding a Stylesheet
44
sidebar_label: Adding Stylesheets
55
---
66

‎docusaurus/docs/adding-images-fonts-and-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: adding-images-fonts-and-files
3-
title: Adding Images, Fonts, And Files
3+
title: Adding Images, Fonts, and Files
44
---
55

66
With Webpack, using static assets like images and fonts works similarly to CSS.

‎docusaurus/docs/alternatives-to-ejecting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: alternatives-to-ejecting
3-
title: Alternatives To Ejecting
3+
title: Alternatives to Ejecting
44
---
55

66
[Ejecting](/docs/available-scripts#npm-run-eject) lets you customize anything, but from that point on you have to maintain the configuration and scripts yourself. This can be daunting if you have many similar projects. In such cases instead of ejecting we recommend to _fork_ `react-scripts` and any other packages you need. [This article](https://auth0.com/blog/how-to-configure-create-react-app/) dives into how to do it in depth. You can find more discussion in [this issue](https://github.com/facebook/create-react-app/issues/682).

‎docusaurus/docs/developing-components-in-isolation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: developing-components-in-isolation
3-
title: Developing Components In Isolation
3+
title: Developing Components in Isolation
44
---
55

66
Usually, in an app, you have a lot of UI components, and each of them has many different states.

‎docusaurus/docs/documentation-intro.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
---
22
id: documentation-intro
3-
title: About The Docs
4-
sidebar_label: About The Docs
3+
title: About the Documentation
4+
sidebar_label: About Docs
55
---
66

7-
Welcome to the documentation! Please navigate via the table of contents to find what you are looking for.
7+
Welcome to the Create React App documentation!
8+
9+
## Navigation
10+
11+
You can find different topics in the table of contents. On desktop, you should see it in the left sidebar. On mobile, you should see it after pressing an icon with arrows in the top left corner.
12+
13+
## Looking for React Docs?
14+
15+
The documentation for React itself is located on a separate website: **[reactjs.org](https://reactjs.org/)**.
16+
17+
This website is only about Create React App.
818

919
## Something Missing?
1020

11-
If you have ideas for more “How To” recipes that should be on this page, [let us know](https://github.com/facebook/create-react-app/issues) or [contribute some!](https://github.com/facebook/create-react-app/edit/master/packages/react-scripts/template/README.md)
21+
If you have ideas for more “How To” recipes that should be on this page, [let us know](https://github.com/facebook/create-react-app/issues) or [contribute some!](https://github.com/facebook/create-react-app/tree/master/docusaurus/docs)
1222

1323
## Feedback
1424

‎docusaurus/docs/importing-a-component.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: importing-a-component
3-
title: Importing A Component
3+
title: Importing a Component
44
---
55

66
This project setup supports ES6 modules thanks to Webpack.<br>

‎docusaurus/docs/installing-a-dependency.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: installing-a-dependency
3-
title: Installing A Dependency
3+
title: Installing a Dependency
44
---
55

66
The generated project includes React and ReactDOM as dependencies. It also includes a set of scripts used by Create React App as a development dependency. You may install other dependencies (for example, React Router) with `npm`:

‎docusaurus/docs/integrating-with-an-api-backend.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: integrating-with-an-api-backend
3-
title: Integrating With An API Backend
4-
sidebar_label: Integrating With An API
3+
title: Integrating with an API Backend
4+
sidebar_label: Integrating with an API
55
---
66

77
These tutorials will help you to integrate your app with an API backend running on another port,

‎docusaurus/docs/making-a-progressive-web-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: making-a-progressive-web-app
3-
title: Making A Progressive Web App
3+
title: Making a Progressive Web App
44
---
55

66
The production build has all the tools necessary to generate a first-class

‎docusaurus/docs/pre-rendering-into-static-html-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: pre-rendering-into-static-html-files
3-
title: Pre-Rendering Into Static HTML Files
3+
title: Pre-Rendering into Static HTML Files
44
sidebar_label: Pre-Rendering Static HTML
55
---
66

‎docusaurus/docs/proxying-api-requests-in-development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: proxying-api-requests-in-development
3-
title: Proxying API Requests In Development
4-
sidebar_label: Proxying In Development
3+
title: Proxying API Requests in Development
4+
sidebar_label: Proxying in Development
55
---
66

77
> Note: this feature is available with `react-scripts@0.2.3` and higher.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: supported-browsers-features
3-
title: Supported Browsers And Features
4-
sidebar_label: Supported Browsers And Features
3+
title: Supported Browsers and Features
4+
sidebar_label: Supported Browsers and Features
55
---
66

77
## Supported Browsers

‎docusaurus/docs/title-and-meta-tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: title-and-meta-tags
3-
title: Title And Meta Tags
3+
title: Title and Meta Tags
44
sidebar_label: Title & Meta Tags
55
---
66

‎docusaurus/docs/updating-to-new-releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: updating-to-new-releases
3-
title: Updating To New Releases
3+
title: Updating to New Releases
44
---
55

66
Create React App is divided into two packages:

‎docusaurus/docs/using-https-in-development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: using-https-in-development
3-
title: Using HTTPS In Development
4-
sidebar_label: HTTPS In Development
3+
title: Using HTTPS in Development
4+
sidebar_label: HTTPS in Development
55
---
66

77
> Note: this feature is available with `react-scripts@0.4.0` and higher.

‎docusaurus/docs/using-the-public-folder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: using-the-public-folder
3-
title: Using The public Folder
3+
title: Using the Public Folder
44
---
55

66
> Note: this feature is available with `react-scripts@0.5.0` and higher.

‎docusaurus/website/core/Footer.js

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,18 @@
88
const React = require('react');
99

1010
class Footer extends React.Component {
11-
docUrl(doc, language) {
11+
docUrl(doc) {
12+
// FIXME: this is a second argument but for some reason /en/ links don't work.
13+
let language = '';
14+
1215
const baseUrl = this.props.config.baseUrl;
1316
return `${baseUrl}docs/${language ? `${language}/` : ''}${doc}`;
1417
}
1518

16-
pageUrl(doc, language) {
19+
pageUrl(doc) {
20+
// FIXME: this is a second argument but for some reason /en/ links don't work.
21+
let language = '';
22+
1723
const baseUrl = this.props.config.baseUrl;
1824
return baseUrl + (language ? `${language}/` : '') + doc;
1925
}
@@ -34,11 +40,15 @@ class Footer extends React.Component {
3440
</a>
3541
<div>
3642
<h5>Docs</h5>
37-
<a href={this.docUrl('documentation-intro', this.props.language)}>
38-
About The Docs
39-
</a>
4043
<a href={this.docUrl('getting-started', this.props.language)}>
41-
Getting Started
44+
Get Started
45+
</a>
46+
<a
47+
href="https://reactjs.org/"
48+
target="_blank"
49+
rel="noreferrer noopener"
50+
>
51+
Learn React
4252
</a>
4353
</div>
4454
<div>
@@ -50,8 +60,8 @@ class Footer extends React.Component {
5060
>
5161
Stack Overflow
5262
</a>
53-
<a
54-
href="https://spectrum.chat/react"
63+
<a
64+
href="https://spectrum.chat/react"
5565
target="_blank"
5666
rel="noreferrer noopener"
5767
>
@@ -67,7 +77,9 @@ class Footer extends React.Component {
6777
</div>
6878
<div>
6979
<h5>More</h5>
70-
<a href="https://www.github.com/facebook/create-react-app">GitHub</a>
80+
<a href="https://www.github.com/facebook/create-react-app">
81+
GitHub
82+
</a>
7183
<a
7284
className="github-button"
7385
href={this.props.config.repoUrl}

‎docusaurus/website/i18n/en.json

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
"tagline": "Set up a modern web app by running one command.",
77
"docs": {
88
"adding-a-css-modules-stylesheet": {
9-
"title": "Adding A CSS Modules Stylesheet",
9+
"title": "Adding a CSS Modules Stylesheet",
1010
"sidebar_label": "Adding CSS Modules"
1111
},
1212
"adding-a-router": {
13-
"title": "Adding A Router"
13+
"title": "Adding a Router"
1414
},
1515
"adding-a-sass-stylesheet": {
16-
"title": "Adding A Sass Stylesheet",
16+
"title": "Adding a Sass Stylesheet",
1717
"sidebar_label": "Adding Sass Stylesheets"
1818
},
1919
"adding-a-stylesheet": {
20-
"title": "Adding A Stylesheet",
20+
"title": "Adding a Stylesheet",
2121
"sidebar_label": "Adding Stylesheets"
2222
},
2323
"adding-bootstrap": {
@@ -31,7 +31,7 @@
3131
"title": "Adding Flow"
3232
},
3333
"adding-images-fonts-and-files": {
34-
"title": "Adding Images, Fonts, And Files"
34+
"title": "Adding Images, Fonts, and Files"
3535
},
3636
"adding-relay": {
3737
"title": "Adding Relay"
@@ -40,7 +40,7 @@
4040
"title": "Advanced Configuration"
4141
},
4242
"alternatives-to-ejecting": {
43-
"title": "Alternatives To Ejecting"
43+
"title": "Alternatives to Ejecting"
4444
},
4545
"analyzing-the-bundle-size": {
4646
"title": "Analyzing the Bundle Size",
@@ -65,11 +65,11 @@
6565
"sidebar_label": "Deployment"
6666
},
6767
"developing-components-in-isolation": {
68-
"title": "Developing Components In Isolation"
68+
"title": "Developing Components in Isolation"
6969
},
7070
"documentation-intro": {
71-
"title": "About The Docs",
72-
"sidebar_label": "About The Docs"
71+
"title": "About the Documentation",
72+
"sidebar_label": "About Docs"
7373
},
7474
"fetching-data-with-ajax-requests": {
7575
"title": "Fetching Data with AJAX Requests",
@@ -82,28 +82,28 @@
8282
"title": "Getting Started"
8383
},
8484
"importing-a-component": {
85-
"title": "Importing A Component"
85+
"title": "Importing a Component"
8686
},
8787
"installing-a-dependency": {
88-
"title": "Installing A Dependency"
88+
"title": "Installing a Dependency"
8989
},
9090
"integrating-with-an-api-backend": {
91-
"title": "Integrating With An API Backend",
92-
"sidebar_label": "Integrating With An API"
91+
"title": "Integrating with an API Backend",
92+
"sidebar_label": "Integrating with an API"
9393
},
9494
"making-a-progressive-web-app": {
95-
"title": "Making A Progressive Web App"
95+
"title": "Making a Progressive Web App"
9696
},
9797
"post-processing-css": {
9898
"title": "Post-Processing CSS"
9999
},
100100
"pre-rendering-into-static-html-files": {
101-
"title": "Pre-Rendering Into Static HTML Files",
101+
"title": "Pre-Rendering into Static HTML Files",
102102
"sidebar_label": "Pre-Rendering Static HTML"
103103
},
104104
"proxying-api-requests-in-development": {
105-
"title": "Proxying API Requests In Development",
106-
"sidebar_label": "Proxying In Development"
105+
"title": "Proxying API Requests in Development",
106+
"sidebar_label": "Proxying in Development"
107107
},
108108
"running-tests": {
109109
"title": "Running Tests"
@@ -113,29 +113,29 @@
113113
"sidebar_label": "Editor Setup"
114114
},
115115
"supported-browsers-features": {
116-
"title": "Supported Browsers And Features",
117-
"sidebar_label": "Supported Browsers And Features"
116+
"title": "Supported Browsers and Features",
117+
"sidebar_label": "Supported Browsers and Features"
118118
},
119119
"title-and-meta-tags": {
120-
"title": "Title And Meta Tags",
120+
"title": "Title and Meta Tags",
121121
"sidebar_label": "Title & Meta Tags"
122122
},
123123
"troubleshooting": {
124124
"title": "Troubleshooting",
125125
"sidebar_label": "Troubleshooting"
126126
},
127127
"updating-to-new-releases": {
128-
"title": "Updating To New Releases"
128+
"title": "Updating to New Releases"
129129
},
130130
"using-global-variables": {
131131
"title": "Using Global Variables"
132132
},
133133
"using-https-in-development": {
134-
"title": "Using HTTPS In Development",
135-
"sidebar_label": "HTTPS In Development"
134+
"title": "Using HTTPS in Development",
135+
"sidebar_label": "HTTPS in Development"
136136
},
137137
"using-the-public-folder": {
138-
"title": "Using The public Folder"
138+
"title": "Using the Public Folder"
139139
}
140140
},
141141
"links": {

‎docusaurus/website/pages/en/index.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,7 @@ class HomeSplash extends React.Component {
7777
<ProjectTitle />
7878
<PromoSection>
7979
<Button href={docUrl('getting-started', language)}>
80-
Getting Started
81-
</Button>
82-
<Button href={docUrl('documentation-intro', language)}>
83-
Documentation
80+
Get Started
8481
</Button>
8582
</PromoSection>
8683
</div>

0 commit comments

Comments
 (0)