coderoad-vscode icon indicating copy to clipboard operation
coderoad-vscode copied to clipboard

Create walkthrough tutorial to explain how CodeRoad works

Open ShMcK opened this issue 5 years ago • 4 comments

ShMcK avatar Apr 05 '20 23:04 ShMcK

Can I take on this one?

SavvyShah avatar Aug 19 '20 10:08 SavvyShah

That'd be great!

I'd recommend to start with writing out the TUTORIAL.md completely first, you could even link to it and share it for feedback/review. If the content is great, the next step is the code.

Let me know if you have any questions or need help with something.

ShMcK avatar Aug 19 '20 14:08 ShMcK

Should we build upon this walkthrough? I've made a TUTORIAL.md here.. Have a look at what levels should be there in this tutorial.

SavvyShah avatar Aug 20 '20 09:08 SavvyShah

I see CodeRoad as having two types of users:

  • creators
  • learners

I think to start its good just to the learners what CodeRoad is. An example tutorial that demonstrates the product.

  • runs on save
  • show is running tests in the background
  • show some hooks/actions
  • show is built on git
  • show example tutorial markdown
  • show a subtask example
  • maybe show works with multiple coding languages if possible

Not necessarily in that order.

Then I hope to use that tutorial to run tests against to make sure nothing is broken. Currently I have to test on a number of tutorials.

Happy to brainstorm on a call if that helps. Just email me.

ShMcK avatar Aug 20 '20 13:08 ShMcK