update docs

Author: ShMcK

_includes/docs/docs.html

@@ -1,7 +1,7 @@
 <link rel="stylesheet" type="text/css" href="/css/docs.min.css" />
 
 <section id="docs">
-  <div class="container">
+  <div class="container bs-docs-container">
     <div class="row">
 
 
@@ -13,11 +13,9 @@ <h1 id="overview" class="page-header">Overview</h1>
             CodeRoad aims to make building & sharing interactive tutorials as easy as possible.
           </blockquote>
 
-          <div class="lead">
-            For a quick overview of how everything comes together&nbsp;&nbsp;&nbsp;
-            <a href="/build" class="btn btn-default btn-lg"><i class="fa fa-road fa-fw"></i> <span class="network-name">Read this</span></a>
+          <div class="lead">We hope to create fun and maintainable coding tutorials that actually improve with time. We hope to create a world where students become teachers, teachers become empowered & coders become better, faster. But first, we need to get some tutorials built.</div>
 
-          </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>
 
           <br> {% for post in site.posts reversed %}
 

_includes/docs/js.html

@@ -0,0 +1,34 @@
+<script type="text/javascript">
+$(function(){
+  // build side menu
+  var html = '';
+
+  $('.bs-docs-section').each(function() {
+    var h1 = $(this).find('h1[id]').first(),
+        h23 = $(this).find('h2[id], h3[id]');
+
+    if (h1.length) {
+      html+= '<li><a href="#' + h1[0].id +'">'+ h1.clone().children().remove().end().text() +'</a>';
+
+      if (h23.length) {
+        html+= '<ul class="nav">';
+        h23.each(function() {
+          html+= '<li><a href="#' + this.id +'">'+ $(this).clone().children().remove().end().text() +'</a></li>';
+        });
+        html+= '</ul>';
+      }
+
+      html+= '</li>';
+    }
+  });
+
+  if (html == '') {
+    $('[role=complementary]').hide();
+    $('[role=main]').toggleClass('col-md-9 col-md-12');
+  }
+  else {
+    $('.bs-docs-sidenav').html(html);
+  }
+
+  !function(a){a(function(){if(navigator.userAgent.match(/IEMobile\/10\.0/)){var b=document.createElement("style");b.appendChild(document.createTextNode("@-ms-viewport{width:auto!important}")),document.querySelector("head").appendChild(b)}{var c=a(window),d=a(document.body);a(".navbar").outerHeight(!0)+10}d.scrollspy({target:".bs-docs-sidebar"}),c.on("load",function(){d.scrollspy("refresh")}),a(".bs-docs-container [href=#]").click(function(a){a.preventDefault()}),setTimeout(function(){var b=a(".bs-docs-sidebar");b.affix({offset:{top:function(){var c=b.offset().top,d=parseInt(b.children(0).css("margin-top"),10),e=a(".bs-docs-nav").height();return this.top=c-e-d},bottom:function(){return this.bottom=a(".bs-docs-footer").outerHeight(!0)}}})},100),setTimeout(function(){a(".bs-top").affix()},100)})}(jQuery);
+  </script>

_layouts/docs.html

@@ -8,5 +8,6 @@
 		{% include docs/docs.html %}
     {% include docs/footer.html %}
 		{% include js.html %}
+		{% include docs/js.html %}
 	</body>
 </html>

_posts/2016-01-03-tutorial.md

@@ -3,22 +3,36 @@ layout: docs
 title: Tutorial File
 id: tutorial
 ---
-Description
+CodeRoad tutorials are written in Github Flavored Markdown, then parsed into a *coderoad.json* file when you run `> coderoad build`.
 
 ### Markdown
 
-### Syntax
+Each level of header indicates a different section, followed by a description.
 
-#### @import
+* `#`   Project
+* `##`  Chapter
+* `###` Page
+* `+`   Task
 
-#### @test
+As an example:
 
-#### @hint
+      # Project Title
+      A description of your project
 
-#### @action
+      ## Chapter One Title
+      A description of chapter one
 
-* open
+      ### Page One Title
+      A description of page one
 
-* set
+      + A description of task one
 
-* insert
+      + A description of task two
+
+      ### Page Two Title
+      A description of page two
+
+      ## Chapter Two Title
+      etc.
+
+[Read more](https://help.github.com/articles/working-with-advanced-formatting/) about Github Flavored Markdown, including how to write tables & syntax highlight code blocks.

_posts/2016-01-04-coderoad-api.md

@@ -0,0 +1,100 @@
+---
+layout: docs
+title: CodeRoad API
+id: coderoad-API
+---
+
+Of course Markdown couldn't cover all uses necessary for CodeRoad. Instead, there is a special **CodeRoad API** which is parsed into the data file whenever you run `> coderoad build`.
+
+For these API features to work, they must be placed at the beginning of a line.
+
+    @import('file')           // ✓
+      @import('file')         // ✗
+
+Features can be commented out, allowing you to view different files at a time. Be aware the parser matches content from the beginning of a line.
+
+    <!-- @import('file') -->  // ✗
+    <!-- @import('file')      // ✗
+    @import('file2') -->      // ✓
+
+### `@import`
+
+*@import* loads other markdown files. Specify a relative path from the root project directory. If no file extension is provided, it will default to *.md*.
+
+      @import('./path/to/file')
+      @import('./path/to/file.md')
+
+See an [example](https://github.com/coderoad/coderoad-functional-school/blob/master/tutorial/tutorial.md).
+
+
+### `@test`
+
+Defaults for loading tests are specified in the tutorial *package.json* file.
+
+      "config": {
+        "testDir": "tutorial",     // the directory name tests paths will load from
+        "testSuffix": ".spec.js"   // the test file suffix that will be added
+      }
+
+*@test* loads a test file. It is important that these files are loaded in the correct order. *@test* can take a single test file, or an array of test files.
+
+      @test('path/to/file')
+      @test(['path/to/file', 'path/to/file2'])
+
+The first example would load the file './tutorial/path/to/file.spec.js' in the project root directory.
+
+### `@hint`
+
+*Note: Hints have not been implemented yet in Atom-Coderoad. Coming soon.*
+
+*@hint* loads a string, or array of strings, which can be used to provide hints for the user.
+
+    @hint('A hint for the user')
+    @hint(['The first hint', 'The second hint'])
+
+*@hint* may use codeblocks with syntax highlighting.
+
+
+    @hint(`var a = 42;`)
+    @hint(```js
+      var a = 42;
+    ```)
+
+### `@action`
+
+*@action* allows you to run changes in the Editor.
+
+#### open
+
+Open a file. The path to the file will be from the users root directory.
+
+    @action(open('file.js'))
+    @action(open('path/to/file.js'))
+
+#### set
+
+Replace all text in a file.
+
+    @action(set('// hello world'))
+    @action(set(`// hello world`))
+    @action(set(```
+      function sayHello() {
+        return 'hello world';
+      }
+    ```))
+
+#### insert
+
+Add text to the bottom of the active text editor.
+
+    @action(insert('// hello world'))
+    @action(insert(`// hello world`))
+    @action(insert(```
+      function sayHello() {
+        return 'hello world';
+      }
+    ```))
+
+#### Future API
+
+More editor actions will be added to CodeRoad in the future.

_posts/2016-01-04-tests.md renamed to _posts/2016-01-05-tests.md

@@ -23,4 +23,8 @@ Description
 * property
 * spies
 
+### Dynamic Tests
+
+* task position
+
 ### Future Testing Tool