Skip to content

Merge/docs #426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 6, 2020
Prev Previous commit
Next Next commit
add notes on how test runner works
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
  • Loading branch information
ShMcK committed Aug 5, 2020
commit c5a86b4316b6dacdcdce60985ce3e23ec6600b3c
19 changes: 19 additions & 0 deletions docs/docs/how-it-works.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: how-coderoad-works
title: How CodeRoad Works
sidebar_label: How CodeRoad Works
---

### Running Tests

In CodeRoad, the user is given a set of directions for a **task**.

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](../images/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?
Binary file added docs/images/test-flow-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.