From 596f48554bfe31b4858d116d9fb1d3e1d41ac549 Mon Sep 17 00:00:00 2001 From: chocolateboy Date: Mon, 19 Mar 2018 16:24:33 +0000 Subject: [PATCH] docs: fix some typos --- docs/docs/create.md | 6 +++--- docs/docs/features-flow.md | 2 +- docs/docs/features-modern.md | 2 +- docs/docs/guides-firebase-functions.md | 4 ++-- docs/docs/guides-heroku.md | 4 ++-- docs/docs/guides-publishing.md | 2 +- docs/docs/introduction.md | 4 ++-- docs/docs/scripts.md | 6 +++--- docs/docs/tutorials-cli.md | 6 +++--- docs/docs/tutorials-express.md | 10 +++++----- docs/docs/tutorials-index.md | 2 +- 11 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/docs/create.md b/docs/docs/create.md index d117e2a..336d699 100644 --- a/docs/docs/create.md +++ b/docs/docs/create.md @@ -6,7 +6,7 @@ sidebar_label: Create In the [introduction](introduction.md), we saw how to create a Noderize app using the `create-noderize` package. -It is recommended you use the single-use script from the [introduction](introduction.md) as it will always be up-to-date, however you can optionally install the command globally with: +It is recommended you use the single-use script from the [introduction](introduction.md) as it will always be up-to-date. However, you can optionally install the command globally with: ```bash yarn global add create-noderize @@ -17,7 +17,7 @@ npm install -g create-noderize create-noderize ``` -Some arguments can be passed to this script to modify it's behavior. +Some arguments can be passed to this script to modify its behavior. ## Index @@ -27,7 +27,7 @@ Some arguments can be passed to this script to modify it's behavior. ### `--typescript` -This will setup a TypeScript project by: +This will set up a TypeScript project by: * Setting the [`language`](configuration-noderize.md#languages) option to `typescript` * Renaming `src/index.js` to `src/index.ts` diff --git a/docs/docs/features-flow.md b/docs/docs/features-flow.md index eaf8e68..6e4a999 100644 --- a/docs/docs/features-flow.md +++ b/docs/docs/features-flow.md @@ -6,7 +6,7 @@ sidebar_label: Flow [Flow](https://flow.org/) is a static type checker that adds types to JavaScript. -Flow is built-in to Noderize, you simply have to add the `flow-bin` command to your project to start using it: +Flow is built-in to Noderize. You simply have to add the `flow-bin` command to your project to start using it: ```bash yarn add -D flow-bin diff --git a/docs/docs/features-modern.md b/docs/docs/features-modern.md index 80db5c2..d4b2566 100644 --- a/docs/docs/features-modern.md +++ b/docs/docs/features-modern.md @@ -4,7 +4,7 @@ title: Feature: Modern JavaScript sidebar_label: Modern JavaScript --- -Noderize enables to use of modern Javascript out-of-the-box with Babel: +Noderize enables the use of modern JavaScript out-of-the-box with Babel: * ES6, ES7, ES8. * Stage 3: Object rest/spread, async generator functions diff --git a/docs/docs/guides-firebase-functions.md b/docs/docs/guides-firebase-functions.md index a54d0fc..a681937 100644 --- a/docs/docs/guides-firebase-functions.md +++ b/docs/docs/guides-firebase-functions.md @@ -12,7 +12,7 @@ To deploy Firebase Cloud Functions, we must: ## Requirements -You must setup the [Firebase CLI](https://github.com/firebase/firebase-tools) before setting up Functions. +You must set up the [Firebase CLI](https://github.com/firebase/firebase-tools) before setting up Functions. Quick Firebase CLI setup: @@ -27,7 +27,7 @@ firebase login ## Project Setup -Create a directory to be used as your project root (for Firebase). Setup Firebase using `firebase init`, and **do not** select the Functions options when creating. +Create a directory to be used as your project root (for Firebase). Set up Firebase using `firebase init`, and **do not** select the Functions options when creating. Next, [create](create.md) a Noderize project inside your project root called `functions`. diff --git a/docs/docs/guides-heroku.md b/docs/docs/guides-heroku.md index 779106d..4c69323 100644 --- a/docs/docs/guides-heroku.md +++ b/docs/docs/guides-heroku.md @@ -4,10 +4,10 @@ title: Guide: Heroku sidebar_label: Heroku --- -Deploy to Heroku is very simple: +Deploying to Heroku is very simple: * Be in a Git repo (optional, `git init`) -* Create an Heroku app using `heroku create [name]` +* Create a Heroku app using `heroku create [name]` * Move `@noderize/scripts` from `devDependencies` to `dependencies` in your `package.json`. * Add `heroku-postbuild` script in `package.json`: ```json diff --git a/docs/docs/guides-publishing.md b/docs/docs/guides-publishing.md index e56fa24..dab75c1 100644 --- a/docs/docs/guides-publishing.md +++ b/docs/docs/guides-publishing.md @@ -37,7 +37,7 @@ By default, npm/Yarn will include these [files](https://docs.npmjs.com/files/pac * NOTICE * The file in the "main" field -When using multiple bundles and/or static files, we must indicate to publish the whole `dist` folder (and optionally include `src` for human-readable code). Add to your `package.json`: +When using multiple bundles and/or static files, we must indicate that the whole `dist` folder should be published (and optionally include `src` for human-readable code). Add to your `package.json`: ```json "files": ["src", "dist"], diff --git a/docs/docs/introduction.md b/docs/docs/introduction.md index d066a11..3177a3d 100644 --- a/docs/docs/introduction.md +++ b/docs/docs/introduction.md @@ -43,7 +43,7 @@ yarn build npm run build ``` -This will build your app to `dist/index.js` (this output is optionally [configurable](configuration-noderize.md#output)) +This will build your app to `dist/index.js` (this output is optionally [configurable](configuration-noderize.md#output)). You can then run your file using the `start` script (for source map support) or using Node directly: @@ -59,4 +59,4 @@ node dist/index.js Noderize is packed with [features](features-index.md) such as [modern JavaScript support](features-modern.md) and [TypeScript support](features-typescript.md). -[Code formatting](features-formatting.md) ([`format` script](scripts.md#format)) and [testing](features-testing.md) ([`test` script](scripts.md#test)) is built-in and let's get work on your high quality code distraction-free. +[Code formatting](features-formatting.md) ([`format` script](scripts.md#format)) and [testing](features-testing.md) ([`test` script](scripts.md#test)) is built-in and lets you get working on your high-quality code distraction-free. diff --git a/docs/docs/scripts.md b/docs/docs/scripts.md index 892c5b8..8043e16 100644 --- a/docs/docs/scripts.md +++ b/docs/docs/scripts.md @@ -4,7 +4,7 @@ title: Noderize Scripts sidebar_label: Scripts --- -Noderize comes build it with commands ("scripts"). These scripts are automatically added to your `package.json` `scripts` field when using [`create-noderize`](create.md): +Noderize comes with commands ("scripts") built-in. These scripts are automatically added to your `package.json` `scripts` field when using [`create-noderize`](create.md): ```json "scripts": { @@ -28,7 +28,7 @@ npm run