Merge pull request #426 from coderoad/merge/docs

Merge/docs

Author: ShMcK

README.md

@@ -6,7 +6,7 @@
 
 CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.
 
-![CodeRoad Image](./docs/images/tutorial-example.png)
+![CodeRoad Image](./docs/static/img/tutorial-example.png)
 
 ## Why
 
@@ -44,6 +44,10 @@ Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.
 - Node.js 10+
 - Git
 
+## How CodeRoad Works
+
+Read more in the docs about [how CodeRoad works](https://coderoad.github.io/docs/how-coderoad-works).
+
 ## Creating Tutorials
 
 Build and share your own interactive tutorials.

docs/docs/how-coderoad-works.md

@@ -0,0 +1,88 @@
+---
+id: how-coderoad-works
+title: How CodeRoad Works
+sidebar_label: How CodeRoad Works
+---
+
+There are really a few major pieces to understand how CodeRoad works.
+
+1. [How Tests Work](#how-tests-work)
+
+2. [How CodeRoad is Built on Git](#built-on-git)
+
+3. [How CodeRoad Hooks & Actions work](#how-hooks-and-actions-work)
+
+### How Tests Work
+
+In CodeRoad, the user is given a set of **levels** composed of one more **tasks**.
+
+![Level / Task Flow](/img/level-task-flow.png)
+
+Each task is judged to pass (✔) or fail (✘) by the result of code tests that runs in the background. Tests can be triggered by saving a file, or by a trigger that listens to specific files for changes.
+
+![Test Flow Diagram](/img/test-flow-diagram.png)
+
+If a test fails, the first failing test name is returned to the user as a hint to identify the problem.
+
+Tests might be in another directory. Those folders or files might even be hidden from you by the tutorial creator.
+
+But where does the code for these tests come from?
+
+### Built on Git
+
+CodeRoad tutorials are stored and loaded using Git, a popular version control system. If you're unfamiliar with Git, think of it as a way to save or load progress from checkpoints called "commits".
+
+![Git Commit Example](/img/git-commit-example.png)
+
+In a tutorial, these commits have a standardized order. First you setup the test runner, then the task tests, then the solution. This pattern is similar to a kind of development called “TDD” or “test driven development”. Write tests for the problem you want to solve, then save the results when all the tests pass. This pattern can also be used to play out a tutorial like a game: users get a task, then must solve it to continue.
+
+![CodeRoad Commit Example](/img/coderoad-commit-example.png)
+
+When a tutorial starts, CodeRoad loads git commits from a tutorial up until the first task commit. These commits contain all of the code setup, test runner configuration and tests for the given task.
+
+![Loading Tutorial Commits](/img/loading-tutorial-commits.png)
+
+When a user passes a task, their progress is saved as a commit. Then the next task commit is loaded.
+
+![Tutorial commits with user solution](/img/tutorial-commits-user-solution.png)
+
+Again notice that the user provides the solution and it is not loaded from the tutorial. This allows users to go a little off-road in a tutorial and provide their own solutions.
+
+#### Why Git
+
+Git provides a number of benefits:
+
+- users can save their progress to a service like GitHub to build a public portfolio
+- users can continue working on their project after a tutorial is completed
+- software developers are largely familiar with Git, and often TDD, making it easy to create tutorials
+- Git provides a mechanism for resolving merge conflicts if they happen to occur
+- Git provides a mechanism for "resetting" a tutorial, see more below!
+
+#### Reset
+
+If at some point the user is a bit too “off-road” from the solution, the user can always return to the “golden path” by pressing the **reset** button. The reset button reloads the commits up to that point entirely from the tutorial.
+
+![Tutorial commits reset example](/img/tutorial-commits-reset.png)
+
+In the example above you can see the user is “reset” back to the original tutorial answers, and back to the second task.
+
+### How Hooks and Actions Work
+
+To make a functional tutorial, tutorial creators need a bit more control over what can be run and when. For example, a test runner wouldn't really work if the package dependencies for that test runner weren't installed.
+
+An **action** is a piece of functionality that can be run. These include:
+
+- `commands` - a list of cli commands to run. For example, "npm install"
+- `vscodeCommands` - a list of vscode API commands to run. For example, "setLayout" to change the layout of windows
+- `watchers` - a list of files to listen to. If a file changes, the test runner will run automatically
+- `files` - a list of files to open in the users workspace to drive the users attention.
+- `subtasks` - a task made up of multiple other tests where all must pass to continue
+- `filter` - a regex passed into the test runner to limit the tests returned
+
+A **hook** in CodeRoad is a place where a tutorial creator can tap in to run an action. Hooks include:
+
+- `config.setup` - when the tutorial setup. This is a great place to setup your test runner.
+- `task.setup` - when a task is started
+- `task.solution` - when a solution is loaded from a [reset](#reset)
+
+Hooks and actions combined provide a flexible environment for tutorial development.

docs/docs/inspiration.md

@@ -0,0 +1,19 @@
+---
+id: inspiration
+title: Inspiration
+sidebar_label: Inspiration
+---
+
+From 2010-2014, I fell in love with interactive coding tutorial. At the time, there were a number of tutorials all built upon the [ACE Editor](https://ace.c9.io/) which allowed for a coding editor experience in the browser. I credit CodeStreet, CodeSchool & Codecademy with providing me the confidence and knowledge to continue with coding.
+
+As a teacher, I hoped to generate my own interactive lesson content to give back to the community that had helped teach me; sadly, I found there were no such tools for creators. Without community based tools to generate content, in my opinion, interactive coding content had stagnated.
+
+In 2016, I developed an earlier version of [CodeRoad using the Atom editor](https://github.com/coderoad/atom-coderoad-deprecated). Atom docs and design towards hackability made it easy to create an interactive tutorial experience. After 6 months I dropped the project, as I found it very difficult to generate and maintain tutorials using the format I had created. I loved the idea, but not the experience I had created.
+
+Years later it hit me that using Git as a tutorial format in CodeRoad would have been a simpler solution for both tutorial creation and consumption. Back in 2015, I had worked on a tutorial series for [Angular-Meteor](https://angular-meteor.com/tutorials/socially/angular2/bootstrap) using [Meteor Tutorial Tools](https://github.com/meteor/tutorial-tools). Meteor tutorial tools showed me that a tutorial can be versioned in Git, and that it can help ensure each step in the tutorial in cohesive and consistent.
+
+The idea of CodeRoad sat with me for years to the point where the product started to feel obvious in my mind. It wasn’t so much that I wanted to build a platform, but it was a tool I wanted to use, and nobody else seemed to be working on it. In mid-2019, I had spent enough time thinking about how it would work that I decided to use my spare time to design and build it.
+
+Shawn McKay
+
+CodeRoad creator

docs/docs/overview.md

@@ -6,7 +6,7 @@ sidebar_label: Overview
 
 CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.
 
-![CodeRoad Image](../images/tutorial-example.png)
+![CodeRoad Image](/img/tutorial-example.png)
 
 ## Why
 

docs/sidebars.js

@@ -1,6 +1,6 @@
 module.exports = {
   someSidebar: {
-    Intro: ['overview', 'setup'],
+    Intro: ['overview', 'setup', 'how-coderoad-works'],
     Build: [
       'build-tutorial',
       'markdown',
@@ -12,7 +12,8 @@ module.exports = {
       'edit-tutorial',
       'create-a-practice-tutorial',
       'examples',
-      'errors'
+      'errors',
     ],
+    More: ['inspiration'],
   },
 }