Skip to content
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

Create walkthrough tutorial to explain how CodeRoad works #212

Open
ShMcK opened this issue Apr 5, 2020 · 4 comments
Open

Create walkthrough tutorial to explain how CodeRoad works #212

ShMcK opened this issue Apr 5, 2020 · 4 comments
Labels
tutorial create a tutorial

Comments

@ShMcK
Copy link
Member

ShMcK commented Apr 5, 2020

No description provided.

@ShMcK ShMcK added the tutorial create a tutorial label Apr 5, 2020
@ShMcK ShMcK added this to the Release milestone Apr 5, 2020
@ShMcK ShMcK removed this from the Release milestone Apr 6, 2020
@ShMcK ShMcK added this to the Post Release Priorities milestone Apr 6, 2020
@ShMcK ShMcK modified the milestones: Stable Release, Basic Features Apr 20, 2020
@ShMcK ShMcK modified the milestones: v0.4, v0.5, v0.6 May 3, 2020
@ShMcK ShMcK removed this from the v0.8 milestone May 21, 2020
@SavvyShah
Copy link
Contributor

SavvyShah commented Aug 19, 2020

Can I take on this one?

@ShMcK
Copy link
Member Author

ShMcK commented Aug 19, 2020

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.

@SavvyShah
Copy link
Contributor

SavvyShah commented Aug 20, 2020

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.

@ShMcK
Copy link
Member Author

ShMcK commented Aug 20, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tutorial create a tutorial
Projects
None yet
Development

No branches or pull requests

2 participants