diff --git a/docs/docs/build-tutorial.md b/docs/docs/build-tutorial.md index c60185eb..89cedff5 100644 --- a/docs/docs/build-tutorial.md +++ b/docs/docs/build-tutorial.md @@ -4,7 +4,7 @@ title: Building a Tutorial sidebar_label: Building a Tutorial --- -A tutorial is made from a github repository that includes three parts: +A tutorial is made from a GitHub repository that includes three parts: 1. Markdown 2. YAML @@ -12,4 +12,4 @@ A tutorial is made from a github repository that includes three parts: 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 each in detail in more detail. +We'll go into each parts in more detail. diff --git a/docs/docs/create-a-practice-tutorial.md b/docs/docs/create-a-practice-tutorial.md index d628e240..35610b19 100644 --- a/docs/docs/create-a-practice-tutorial.md +++ b/docs/docs/create-a-practice-tutorial.md @@ -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 to github +### Commit to GitHub - 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 to github with `git push origin master` +- Push them to GitHub with `git push origin master` ### Create a version branch @@ -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, and most anything 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. @@ -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 and for you 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 .` @@ -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 to github with `git push origin v0.1.0` +- Push your changes to GitHub with `git push origin v0.1.0` ### Create the YAML file -- Go back your your master branch with `git checkout master` +- Go back to 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: @@ -193,14 +193,14 @@ levels: - id: '1.1' ``` -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. +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. - 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 to github with `git push origin master` +- Push it to GitHub with `git push origin master` ### Build the config.json file @@ -259,7 +259,7 @@ Add the DOCTYPE - Add all the files - Commit the files with any message -- Push the changes to github +- Push the changes to GitHub ### Add second lesson test @@ -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 to github to your `v0.1.0` branch +- Push your changes to GitHub to your `v0.1.0` branch ### Update the YAML diff --git a/docs/docs/git-timeline.md b/docs/docs/git-timeline.md index 46b4ec32..01bd6510 100644 --- a/docs/docs/git-timeline.md +++ b/docs/docs/git-timeline.md @@ -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 the id'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 the ID'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 index cd943577..326afd9d 100644 --- a/docs/docs/markdown.md +++ b/docs/docs/markdown.md @@ -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 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. 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 index 163c4fe0..1cb4cb36 100644 --- a/docs/docs/overview.md +++ b/docs/docs/overview.md @@ -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 diff --git a/docs/docs/setup.md b/docs/docs/setup.md index 44de3d89..87cfb6fb 100644 --- a/docs/docs/setup.md +++ b/docs/docs/setup.md @@ -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" diff --git a/docs/docs/yaml.md b/docs/docs/yaml.md index 48060320..407c158e 100644 --- a/docs/docs/yaml.md +++ b/docs/docs/yaml.md @@ -43,7 +43,7 @@ levels: subtasks: false ``` -Note that the id's for each lesson and step match the id's in the markdown. +Note that the ID's for each lesson and step matches the ID's in the markdown. ### Options