Skip to content

Commit 2bff73a

Browse files
committed
Signed-off-by: jordanliu <jordanxavierliu@gmail.com>
docs: formatting and grammar
1 parent d8aaf99 commit 2bff73a

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

Diff for: docs/docs/build-tutorial.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ title: Building a Tutorial
44
sidebar_label: Building a Tutorial
55
---
66

7-
A tutorial is made from a github repository that includes three parts:
7+
A tutorial is made from a GitHub repository that includes three parts:
88

99
1. Markdown
1010
2. YAML
1111
3. Git Commits
1212

1313
The Markdown and YAML live on the master branch of the repo, and the Git commits live on a version branch.
1414

15-
We'll go into each in detail in more detail.
15+
We'll go into each parts in more detail.

Diff for: docs/docs/create-a-practice-tutorial.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ This is the test text. Create an `index.html` file to pass this lesson.
5151

5252
The above tutorial has an introduction page and one lesson.
5353

54-
### Commit to github
54+
### Commit to GitHub
5555

5656
- Back in the terminal, add all your new files to be committed with `git add .`
5757
- Commit them with `git commit -m "create markdown"`
58-
- Push them to github with `git push origin master`
58+
- Push them to GitHub with `git push origin master`
5959

6060
### Create a version branch
6161

@@ -68,7 +68,7 @@ This will make a branch that isn't created from master, so it has no commit hist
6868

6969
### Create your project files
7070

71-
This branch is also where users create their projects, modify files for a tutorial, and most anything they need to do.
71+
This branch is also where users create their projects, modify files for a tutorial, and anything else that they need to do.
7272

7373
- Make a new folder named `coderoad` on your branch.
7474

@@ -93,7 +93,7 @@ This folder will hold as much of the CodeRoad stuff as it can so users aren't co
9393

9494
```
9595

96-
These scripts will be for CodeRoad and you to test things.
96+
These scripts will be for CodeRoad and for you to test things.
9797

9898
- From the terminal, in your `coderoad` folder, run `npm install --save mocha mocha-tap-reporter` to install some depenedencies
9999
- **Go back to the main repo folder** and add your changes with `git add .`
@@ -162,11 +162,11 @@ That stands for "Lesson 1 Step 1 Setup & Tests". You can put an additional note
162162
That stands for "Lesson 1 Step 1 Solution", and it's the solution to the test.
163163

164164
- Take a quick look at the commit history with `git log`. You can see the messages there, they align with the titles you put in the markdown and there's one commit for the test (`1.1`) and an optional commit for the solution (`1.1S`)
165-
- Push your changes to github with `git push origin v0.1.0`
165+
- Push your changes to GitHub with `git push origin v0.1.0`
166166

167167
### Create the YAML file
168168

169-
- Go back your your master branch with `git checkout master`
169+
- Go back to your master branch with `git checkout master`
170170
You can think of these two branches like separate repositories, the branches will never merge and the files will always be different, even if some look the same.
171171
- Create a new file named `coderoad.yaml` and add this to it:
172172

@@ -193,14 +193,14 @@ levels:
193193
- id: '1.1'
194194
```
195195
196-
Replace the `repo uri` URL with your github repo, note that it's just the username and repo in the URL. This file links everything together. You can see the repo URL and the branch that you created. And the `1.` and `1.1` id's that match the markdown. You can also add commands that will run when a lesson is started, as well as a host of other things.
196+
Replace the `repo uri` URL with your GitHub repo, note that it's just the username and repo in the URL. This file links everything together. You can see the repo URL and the branch that you created. And the `1.` and `1.1` ID's that match the markdown. You can also add commands that will run when a lesson has started, as well as a host of other things.
197197

198198
- Add this with `git add .`
199199
- Commit it with `git commit -m "create yaml"`
200200

201201
The commit messages on master can be whatever you want.
202202

203-
- Push it to github with `git push origin master`
203+
- Push it to GitHub with `git push origin master`
204204

205205
### Build the config.json file
206206

@@ -259,7 +259,7 @@ Add the DOCTYPE
259259
260260
- Add all the files
261261
- Commit the files with any message
262-
- Push the changes to github
262+
- Push the changes to GitHub
263263
264264
### Add second lesson test
265265
@@ -307,7 +307,7 @@ There should be one passing and one failing test
307307
- Commit it with a message of "2.1"
308308
- Add the `index.html` file to be committed
309309
- Commit it with a message of "2.1S"
310-
- Push your changes to github to your `v0.1.0` branch
310+
- Push your changes to GitHub to your `v0.1.0` branch
311311

312312
### Update the YAML
313313

Diff for: docs/docs/git-timeline.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ A CodeRoad tutorial runs on Git commits. These will be the commits on the versio
1919

2020
Then repeat steps 2 & 3.
2121

22-
The commit messages for these must start with a level & step number. "1.1" stands for "Lesson 1 Step 1 Setup" and "1.1S" stand for "Lesson 1 Step 1 Solution". The `1.1` part of each commit message needs to match the id's from the markdown and yaml.
22+
The commit messages for these must start with a level & step number. "1.1" stands for "Lesson 1 Step 1 Setup" and "1.1S" stand for "Lesson 1 Step 1 Solution". The `1.1` part of each commit message needs to match the ID's from the markdown and yaml.
2323

2424
You can add additional text after those required characters if you want.

Diff for: docs/docs/markdown.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Test text for 2.2
5757

5858
The example above has an introduction page and two lessons.
5959

60-
The introduction page is first thing users will see when they start a tutorial. It shows an overview of all the lessons and displays the lesson summary.
60+
The introduction page is the first thing users will see when they start a tutorial. It shows an overview of all the lessons and displays the lesson summary.
6161

6262
Lessons need to start with `## x.` where `x` is the lesson number. The text after `x.` will display as the lesson title.
6363

Diff for: docs/docs/overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ Interactive learning is the most effective way to gain new skills and knowledge.
1414

1515
For learners, there are a number of advantages to running tutorials inside VSCode:
1616

17-
- learn in a real world coding environment
18-
- get rapid feedback on save and helpful error messages
19-
- users own the code, and can build a Git timeline and deploy a portfolio
17+
- Learn in a real world coding environment
18+
- Get rapid feedback on save and helpful error messages
19+
- Users own the code, and can build a Git timeline and deploy a portfolio

Diff for: docs/docs/setup.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.
2222

2323
To start the extension, inside VSCode:
2424

25-
- open an empty VSCode workspace (an empty folder)
26-
- launch the app from the VSCode command palette:
27-
- select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
28-
- in the command palette, search for and run `CodeRoad:Start`
29-
- a webview should appear on the right side of your editor. Click "Start"
25+
- Open an empty VSCode workspace (an empty folder)
26+
- Launch the app from the VSCode command palette:
27+
- Select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
28+
- In the command palette, search for and run `CodeRoad:Start`
29+
- A webview should appear on the right side of your editor. Click "Start"

Diff for: docs/docs/yaml.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ levels:
4343
subtasks: false
4444
```
4545
46-
Note that the id's for each lesson and step match the id's in the markdown.
46+
Note that the ID's for each lesson and step matches the ID's in the markdown.
4747
4848
### Options
4949

0 commit comments

Comments
 (0)