docs updates, edits

ShMcK · ShMcK · commit 7f4630eb53c7 · 2016-02-25T23:50:24.000-08:00
diff --git a/_includes/docs/docs.html b/_includes/docs/docs.html
@@ -12,11 +12,11 @@
           <h1 id="overview" class="page-header">Overview</h1>
 
           <blockquote>
-            CodeRoad aims to make building & sharing interactive tutorials as easy as possible.
+            CodeRoad aims to make building & sharing interactive coding tutorials as easy as possible.
           </blockquote>
 
-          <div class="lead">We hope to create fun and maintainable coding tutorials that actually improve with time. We hope to see students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive tutorials built.
-            That's where you come in.</div>
+          <div class="lead">We hope to create fun and maintainable code tutorials that actually improve with time. We hope to see programming students become teachers, teachers become empowered, and coders become better, faster. But first, let's get some interactive coding tutorials built.
+          That's where you come in.</div>
 
           <a href="/build" class="btn btn-default btn-lg"><i class="fa fa-road fa-fw"></i> <span class="network-name">Read an Overview of Building a Tutorial</span></a>
         </section>
diff --git a/_posts/2016-01-04-coderoad-api.md b/_posts/2016-01-04-coderoad-api.md
@@ -62,11 +62,10 @@ See an [example](https://github.com/coderoad/coderoad-functional-school/blob/mas
 
 ### `@hint`
 
-*@hint* loads a string (or array of strings) which can be used to provide hints for the user. The order of hints is important: first in, first out.
+*@hint* loads a string which can be used to provide hints for the user. The order of hints is important: first in, first out.
 
 ```markdown
 @hint('A hint for the user')
-@hint(['Hint 1', 'Hint 2'])
 
 *@hint* may use code-blocks with syntax highlighting, but they must be wrapped in quotes.
 
@@ -121,4 +120,4 @@ Add text to the bottom of the active text editor.
 
 #### What's Next
 
-More editor actions will be added to CodeRoad at a later date.
+More editor actions will be added to CodeRoad at a later date. These may include changing the cursor position, replacing content, decorating keywords, etc.
diff --git a/_posts/2016-01-06-loaders.md b/_posts/2016-01-06-loaders.md
@@ -5,9 +5,9 @@ id: loaders-snippets
 file: 2016-01-06-loaders.md
 ---
 
-Tutorials may be written in different programming languages or for different compilers, so there isn't yet a standard way to load data from user created files. Instead, you'll have to load your own solution into your tutorial and link to them from your test file. Rolling your own solution allows you to load data in a way that fits your project.
+Tutorials may be written in different programming languages or for different compilers, so there isn't yet a standard way to load data from user created files. Instead, you'll have to load/transpile your files for the test runner. Rolling your own solution allows you to load data in a way that fits your project.
 
-These snippets should help:
+There may be a simpler approach in the future, but for now these snippets should help:
 
 
 #### loadJS (JavaScript)
diff --git a/_posts/2016-01-08-config.md b/_posts/2016-01-08-config.md
@@ -17,7 +17,7 @@ CodeRoad tutorial configurations can be set in the *package.json* config.
 }
 ```
 
-This section will likely expand in the future. For now, let's go over some of these.
+This section will likely expand in the future. For now, let's go over some of the configurations.
 
 #### testDir
 
diff --git a/_posts/2016-01-10-test-runner.md b/_posts/2016-01-10-test-runner.md
@@ -4,11 +4,11 @@ title: Test Runners
 id: test-runners
 file: 2016-01-10-test-runner.md
 ---
-A test runner works by creating a child process and calling a test framework with target files.
+A CodeRoad test runner works by creating a child process and calling a test framework with target files, then returning the result as a JSON object.
 
 In this way, the test runner not only determines how unit tests will be written, but it actually determines the programming language used in the tutorial.
 
-> Any programming language could be used with CodeRoad, you need only change the test runner.
+> Any programming language can potentially be used with CodeRoad, you need only change the test runner.
 
 ### Current Test Runners
 
@@ -18,13 +18,13 @@ We need more test runners. Why not build one?
 
 ### How to Build a New Test Runner
 
-If you're interested in helping CodeRoad support a programming language of your choice, here's how to set up the test runner.
+If you're interested in helping CodeRoad support a different programming language or test framework of your choice, here's how to set up the test runner.
 
-The test runner should spawn a child process. Think of this like your program opening up a terminal, typing in command line commands, then collecting and returning the the results to *Atom-CodeRoad*. See [an example child process created in *mocha-coderoad*](https://github.com/coderoad/mocha-coderoad/blob/master/src/create-runner.ts).
+The test runner should spawn a child process. Think of this like your program opening up a terminal, typing in some command line commands to run tests, then collecting and returning the the results to *Atom-CodeRoad*. See [an example child process created inside of Atom for *mocha-coderoad*](https://github.com/coderoad/mocha-coderoad/blob/master/src/create-runner.ts).
 
-The test runner is called with four ordered inputs, two of which act as callback functions that return the log & result to *Atom-CodeRoad*.
+The test runner is called in *Atom-CodeRoad* with four ordered inputs, two of which act as callback functions that return the log or result.
 
-See a brief example from the [*mocha-coderoad* runner](https://github.com/coderoad/mocha-coderoad/blob/master/src/runner.ts).
+See a brief example from the [*mocha-coderoad* runner](https://github.com/coderoad/mocha-coderoad/blob/master/src/runner.ts), as well as a code summary below:
 
 ```js
 export default function runner(testFile, config, handleResult, handleLog) {
@@ -35,15 +35,15 @@ export default function runner(testFile, config, handleResult, handleLog) {
 }
 ```
 
-Let's look at these four inputs in more detail.
+Let's look at these four test runner inputs in more detail.
 
 #### 1. testFile
 
-The absolute path to a file containing all concatenated page tests. Call your test framework with this.
+The absolute path to a file containing all concatenated page tests. Call your test framework with this file path.
 
 #### 2. config
 
-A JSON object of configurations, see an example below
+A JSON object of configurations that may be needed for setting up your runner. See an example below:
 
 ```json
 {
@@ -56,7 +56,10 @@ A JSON object of configurations, see an example below
 
 #### 3. handleResult
 
-A callback function that should be called with the **result** object. Results should either pass if all pass, or fail if any test fails.
+A callback function that should be called with the **result** object. Results should pass if all tests pass, or fail if even a single test fails.
+
+The result should output the *taskPosition* after the test. The field *change* represents the difference between the starting 'taskPosition' and the resulting 'taskPosition'.
+
 
 ##### pass
 
@@ -69,8 +72,6 @@ A callback function that should be called with the **result** object. Results sh
 }
 ```
 
-The result should output the 'taskPosition' after the test. 'change' represents the difference between the starting 'taskPosition' and the resulting 'taskPosition'.
-
 ##### fail
 
 ```json
@@ -85,6 +86,6 @@ The result should output the 'taskPosition' after the test. 'change' represents
 
 #### 4. handleLog
 
-A callback function that should be called with a string **log** statement
+A callback function that should return the output **log** statement. 
 
 *If you need help setting up a new test runner, please send an email to coderoadapp@gmail.com.*

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ CodeRoad tutorial configurations can be set in the package.json config.`
`17`	`17`	`}`
`18`	`18`	```
`19`	`19`
`20`		`-This section will likely expand in the future. For now, let's go over some of these.`
	`20`	`+This section will likely expand in the future. For now, let's go over some of the configurations.`
`21`	`21`
`22`	`22`	`#### testDir`
`23`	`23`