Aug 6, 2020 · Aug 6, 2020 · Aug 6, 2020 · Aug 6, 2020 · Aug 6, 2020
diff --git a/docs/docs/build-tutorial.md b/docs/docs/build-tutorial.md
 sidebar_label: Building a Tutorial
 ---

 A tutorial is made from agithub repository that includes three parts:
 A tutorial is made from aGitHub repository that includes three parts:

 1. Markdown
 2. YAML
 3. Git Commits

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

 We'll go into eachin detail in more detail.
 We'll go into eachparts in more detail.
diff --git a/docs/docs/create-a-practice-tutorial.md b/docs/docs/create-a-practice-tutorial.md

 The above tutorial has an introduction page and one lesson.

 ### Commit togithub
 ### Commit toGitHub

 - Back in the terminal, add all your new files to be committed with `git add .`
 - Commit them with `git commit -m "create markdown"`
 - Push them togithub with `git push origin master`
 - Push them toGitHub with `git push origin master`

 ### Create a version branch


 ### Create your project files

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

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


 ```

 These scripts will be for CodeRoad and you to test things.
 These scripts will be for CodeRoad andforyou to test things.

 - From the terminal, in your `coderoad` folder, run `npm install --save mocha mocha-tap-reporter` to install some depenedencies
 - **Go back to the main repo folder** and add your changes with `git add .`
 That stands for "Lesson 1 Step 1 Solution", and it's the solution to the test.

 - 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`)
 - Push your changes togithub with `git push origin v0.1.0`
 - Push your changes toGitHub with `git push origin v0.1.0`

 ### Create the YAML file

 - Go backyour your master branch with `git checkout master`
 - Go backto your master branch with `git checkout master`
  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.
 - Create a new file named `coderoad.yaml` and add this to it:

      - id: '1.1'
 ```

 Replace the `repo uri` URL with yourgithub 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 lessonis started, as well as a host of other things.
 Replace the `repo uri` URL with yourGitHub 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 lessonhas started, as well as a host of other things.

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

 The commit messages on master can be whatever you want.

 - Push it togithub with `git push origin master`
 - Push it toGitHub with `git push origin master`

 ### Build the config.json file


 - Add all the files
 - Commit the files with any message
 - Push the changes togithub
 - Push the changes toGitHub

 ### Add second lesson test

 - Commit it with a message of "2.1"
 - Add the `index.html` file to be committed
 - Commit it with a message of "2.1S"
 - Push your changes togithub to your `v0.1.0` branch
 - Push your changes toGitHub to your `v0.1.0` branch

 ### Update the YAML

diff --git a/docs/docs/git-timeline.md b/docs/docs/git-timeline.md

 Then repeat steps 2 & 3.

 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 theid's from the markdown and yaml.
 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 theID's from the markdown and yaml.

 You can add additional text after those required characters if you want.
diff --git a/docs/docs/markdown.md b/docs/docs/markdown.md

 The example above has an introduction page and two lessons.

 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.
 The introduction page isthefirst thing users will see when they start a tutorial. It shows an overview of all the lessons and displays the lesson summary.

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

diff --git a/docs/docs/overview.md b/docs/docs/overview.md

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

 -learn in a real world coding environment
 -get rapid feedback on save and helpful error messages
 -users own the code, and can build a Git timeline and deploy a portfolio
 -Learn in a real world coding environment
 -Get rapid feedback on save and helpful error messages
 -Users own the code, and can build a Git timeline and deploy a portfolio
diff --git a/docs/docs/setup.md b/docs/docs/setup.md

 To start the extension, inside VSCode:

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

 Note that theid's for each lesson and stepmatch theid's in the markdown.
 Note that theID's for each lesson and stepmatches theID's in the markdown.

 ### Options

diff --git a/docs/images/tutorial-example.png b/docs/images/tutorial-example.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,12 +4,12 @@ title: Building a Tutorial
		sidebar_label: Building a Tutorial
		---

		A tutorial is made from agithub repository that includes three parts:
		A tutorial is made from aGitHub repository that includes three parts:

		1. Markdown
		2. YAML
		3. Git Commits

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

		We'll go into eachin detail in more detail.
		We'll go into eachparts in more detail.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -51,11 +51,11 @@ This is the test text. Create an `index.html` file to pass this lesson.

		The above tutorial has an introduction page and one lesson.

		### Commit togithub
		### Commit toGitHub

		- Back in the terminal, add all your new files to be committed with `git add .`
		- Commit them with `git commit -m "create markdown"`
		- Push them togithub with `git push origin master`
		- Push them toGitHub with `git push origin master`

		### Create a version branch

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

		### Create your project files

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

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

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

		```

		These scripts will be for CodeRoad and you to test things.
		These scripts will be for CodeRoad andforyou to test things.

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

		- 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`)
		- Push your changes togithub with `git push origin v0.1.0`
		- Push your changes toGitHub with `git push origin v0.1.0`

		### Create the YAML file

		- Go backyour your master branch with `git checkout master`
		- Go backto your master branch with `git checkout master`
		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.
		- Create a new file named `coderoad.yaml` and add this to it:

Expand All		@@ -193,14 +193,14 @@ levels:
		- id: '1.1'
		```

		Replace the `repo uri` URL with yourgithub 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 lessonis started, as well as a host of other things.
		Replace the `repo uri` URL with yourGitHub 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 lessonhas started, as well as a host of other things.

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

		The commit messages on master can be whatever you want.

		- Push it togithub with `git push origin master`
		- Push it toGitHub with `git push origin master`

		### Build the config.json file

Expand DownExpand Up		@@ -259,7 +259,7 @@ Add the DOCTYPE

		- Add all the files
		- Commit the files with any message
		- Push the changes togithub
		- Push the changes toGitHub

		### Add second lesson test

Expand DownExpand Up		@@ -307,7 +307,7 @@ There should be one passing and one failing test
		- Commit it with a message of "2.1"
		- Add the `index.html` file to be committed
		- Commit it with a message of "2.1S"
		- Push your changes togithub to your `v0.1.0` branch
		- Push your changes toGitHub to your `v0.1.0` branch

		### Update the YAML

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,6 +19,6 @@ A CodeRoad tutorial runs on Git commits. These will be the commits on the versio

		Then repeat steps 2 & 3.

		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 theid's from the markdown and yaml.
		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 theID's from the markdown and yaml.

		You can add additional text after those required characters if you want.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -57,7 +57,7 @@ Test text for 2.2

		The example above has an introduction page and two lessons.

		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.
		The introduction page isthefirst thing users will see when they start a tutorial. It shows an overview of all the lessons and displays the lesson summary.

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

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,6 +14,6 @@ Interactive learning is the most effective way to gain new skills and knowledge.

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

		-learn in a real world coding environment
		-get rapid feedback on save and helpful error messages
		-users own the code, and can build a Git timeline and deploy a portfolio
		-Learn in a real world coding environment
		-Get rapid feedback on save and helpful error messages
		-Users own the code, and can build a Git timeline and deploy a portfolio
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,8 +22,8 @@ Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.

		To start the extension, inside VSCode:

		-open an empty VSCode workspace (an empty folder)
		-launch the app from the VSCode command palette:
		-select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
		-in the command palette, search for and run `CodeRoad:Start`
		-a webview should appear on the right side of your editor. Click "Start"
		-Open an empty VSCode workspace (an empty folder)
		-Launch the app from the VSCode command palette:
		-Select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
		-In the command palette, search for and run `CodeRoad:Start`
		-A webview should appear on the right side of your editor. Click "Start"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,7 +43,7 @@ levels:
		subtasks: false
		```

		Note that theid's for each lesson and stepmatch theid's in the markdown.
		Note that theID's for each lesson and stepmatches theID's in the markdown.

		### Options

Expand Down