Skip to content

Docs development #446

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 3 commits into from
Aug 16, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
clean up overview/setup docs
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
  • Loading branch information
ShMcK committed Aug 16, 2020
commit e7829f14f6e71063308ba573559e0056a298112b
26 changes: 20 additions & 6 deletions docs/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,26 @@ CodeRoad is a VSCode extension that allows you to play interactive coding tutori

![CodeRoad Image](/gif/coderoad-example.gif)

## Why
CodeRoad is a platform for creating and playing interactive coding education tutorials.

Interactive learning is the most effective way to gain new skills and knowledge. CodeRoad aims to help tutorial creators develop and share interactive content with the community.
What makes CodeRoad different?

For learners, there are a number of advantages to running tutorials inside VSCode:
## Real-World Experience

- 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
CodeRoad is the first tutorial platform to run in a real coding environment: Microsoft’s VSCode editor. As you play, the editor provides access to the same extensions and features real developers use.

Users love CodeRoad because it provides them more than just a certificate of completion. CodeRoad tutorials are made out of Git commits that provide a public-facing view of your progress to share on the social network for developers: GitHub. In addition, you build a portfolio in CodeRoad: write real code, push it to GitHub, and deploy your projects to the cloud. In the end, you have something for your efforts to build upon, customize, and show to peers or potential employers.

## A Better Way To Learn

It’s no secret that computer science departments have the highest dropout rates, and the number is even worse with online coding programs where 94% of students give up. When I was learning to code, I almost quit many times - only later did I recognize I struggled because the courses didn’t align well with how people learn.

Learning is the process of transferring knowledge from one medium into the user's mind. Similar to other interactive coding platforms like Codecademy or CodeSchool, I’ve aligned CodeRoad with the science of learning: practice doing, quick feedback, gamification, and hints or help when learners get stuck.

As long as interactive content remains difficult to produce, the primary medium for coding education will still be video and text. The tools for interactive content just haven’t been available… until CodeRoad.

## Create Tutorials

The primary focus of CodeRoad is to make producing interactive content simpler. Simple enough that a tutorial can be made in the same way as regular software - with unit tests, git commits, and basic documentation. CodeRoad is a working project today, and I have plans to make the process even smoother.

The ability of a software developer to generate interactive content is a big deal. With CodeRoad, creators can now produce one-click launching tutorials in a browser or even run them locally on a user's machine.
23 changes: 10 additions & 13 deletions docs/docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,23 @@ title: Setup
sidebar_label: Setup
---

### Install

Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad).

- You may need to reload the window (`ctrl/cmd + R`)
- See ["Start"](#start) to get started.

### Requirements

- OS: MacOS, Windows, Linux
- VSCode 1.39.2+
- Node.js 12+
- Git

### Install

Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad).

Once installed, reload the window (`ctrl/cmd + R`) to get started.

### Start

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 (a project folder)
- Launch the app from the VSCode command palette. How?
- select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
- in the command palette popup, search for and run `CodeRoad:Start`