It would be good to have more clarity on how to create a functioning tutorial git repo - What are the minimum set of files needed for it to work - I’ve had patchy results resulting in a lot of delay.
Perhaps there is a simpler way to create small scale tutorials like the one above without creating a git repo for each one.
Course Home Page
It would be great to be able to create a course that would live https://arcade.makecode.com/courses/ or at least be able to use the similar documentation process.
I’ll be recording videos this afternoon on how to create user tutorials. If you go to https://arcade.makecode.com/beta you will get additional support for tutorials:
all .md files have a “external” icon in the explorer that provides a tutorial preview
if you change the language of the editor, all .md files have a globe icon to add the localized version
I’ll review your tutorials later this afternoon.
I wasn’t sure how to navigate to this kind of edit page on #beta for the tutorials created in the tool or in Github. So I created one from scratch on the beta site, edited the README.md and added two more md files.
But the link routing isn’t working from that first README - I’ve tried the following way
## Adding an Enemy
### Getting Started @unplugged
This is tutorial one in a group that add game mechanics to our starter template, for more see.
* [Part One](partOne.md)
* [Part Two](partTwo.md)
These steps are part of other which you can find on the home page of this Platformer Making Course. (course link to come)
You’ll definitely want to use a GitHub repository to host your tutorials. The shared projects don’t support sub-file routing (and probably never will).
I published a tutorial for micro:bit about creating tutorials; but it also applies to arcade.makecode.com/beta
As for cross linking tutorials, let me see today about streamlining this. We do turn on GitHub Pages for repositories – so every https://github.com/OWNER/NAME repository also has a compiled jekyll web site https://OWNER.github.io/NAME web site which starts with the rendered README.md file.
From there you could link to the deep link to the tutorials. I will publish a guide about it.
Thanks this is helpful - I’ll get there
I’ve added a comment in the following video about navigating back to the editor in beta - I think this is one of my problems at the moment.
Hi there,
Thanks again for your help so far. I’ve created one repository with all my tutorials in it now. And I can pull that into the editor at /beta via Import on the front page.
I’m still struggling away with these links.
I am getting a lot of inconsistencies and errors.
For example I’ve created the same file in the following locations
I hope using the same file in those two locations is helpful. I’ve been playing around with a lot of different links and trying to get consistent results but not managing. Also are their caching issues when using github? and Can I get around them somehow when testing.
We’ve pushed a fix to beta. You might have to reset your editor to make it work (make sure you save all your scripts).
We used to prefer using the github token if available. We’ve changed to always try the github proxy and bail out to using the token if failed. To avoid caching issues, I would strongly recommend to create releases of your repo. MakeCode will pick the latest release.
Hi there, that makes a lot of sense - I got the impression that I was “trying too hard” somehow - like a watched kettle never boils - and that kind of explains it.
I think a problem was I had all my course material in one repo. So updates were causing problems.
I’ve separated off the Make Code tutorial parts from the others and should be all good from now on.
