Skip to content

Commit 10cbdd0

Browse files
committed
add overview docs
Signed-off-by: shmck <shawn.j.mckay@gmail.com>
1 parent e5e7ba5 commit 10cbdd0

File tree

4 files changed

+45
-4
lines changed

4 files changed

+45
-4
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ CodeRoad is a VSCode extension that allows you to play interactive coding tutori
1313
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.
1414

1515
For learners, there are a number of advantages to running tutorials inside VSCode:
16+
1617
- learn in a real world coding environment
1718
- get rapid feedback on save and helpful error messages
1819
- users own the code, and can build a Git timeline and deploy a portfolio
1920

20-
2121
## Getting Started
2222

2323
### Start
@@ -48,7 +48,7 @@ Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.
4848

4949
Build and share your own interactive tutorials.
5050

51-
Learn more about [how tutorials area created](./docs/tutorials.md).
51+
Learn more about [how tutorials area created](https://coderoad.github.io/docs/build-tutorial).
5252

5353
See an [interactive visualization](https://coderoad.github.io/coderoad-visual/) of a tutorial repository.
5454

docs/docs/overview.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,16 @@ title: Overview
44
sidebar_label: Overview
55
---
66

7-
Coming Soon
7+
CodeRoad is a VSCode extension that allows you to play interactive coding tutorials in your editor.
8+
9+
![CodeRoad Image](../images/tutorial-example.png)
10+
11+
## Why
12+
13+
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.
14+
15+
For learners, there are a number of advantages to running tutorials inside VSCode:
16+
17+
- learn in a real world coding environment
18+
- get rapid feedback on save and helpful error messages
19+
- users own the code, and can build a Git timeline and deploy a portfolio

docs/docs/setup.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
id: setup
3+
title: Setup
4+
sidebar_label: Setup
5+
---
6+
7+
### Install
8+
9+
Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad).
10+
11+
- You may need to reload the window (`ctrl/cmd + R`)
12+
- See ["Start"](#start) to get started.
13+
14+
### Requirements
15+
16+
- OS: MacOS, Windows, Linux
17+
- VSCode 1.39.2+
18+
- Node.js 10+
19+
- Git
20+
21+
### Start
22+
23+
To start the extension, inside VSCode:
24+
25+
- open an empty VSCode workspace (an empty folder)
26+
- launch the app from the VSCode command palette:
27+
- select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
28+
- in the command palette, search for and run `CodeRoad:Start`
29+
- a webview should appear on the right side of your editor. Click "Start"

docs/sidebars.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module.exports = {
22
someSidebar: {
3-
Intro: ['overview'],
3+
Intro: ['overview', 'setup'],
44
Build: [
55
'build-tutorial',
66
'markdown',

0 commit comments

Comments
 (0)