4 ms·
I built this approach at a hackathon with a friend, it's something that enables people to teach about code by inspecting different parts of a pre-existing proje
by djmashko2 10y ago
I built this approach at a hackathon with a friend, it's something that enables people to teach about code by inspecting different parts of a pre-existing project: https://www.codetours.xyz/ https://www.codetours.xyz/
Never took the extra time to polish it up after the hackathon, but if someone is interested I'd be happy to work together on improvements.
- mthoms 10y agoWow. I think this could be incredibly useful.
- markm208 10y agoI already posted to the original but thought I would chime in. I like the idea of guiding someone through some code with a narrative. Your tool is very helpful for this. I have a similar tool but it allows the comments to be added to the code as it evolves: https://github.com/markm208/storyteller#storyteller https://github.com/markm208/storyteller#storyteller The main difference being that the context of the comment is always in line with code at the point the comment is made. One other difference is that a person can add drawings and audio to their comments.
- ivan_ah 10y agoVery nice! In particular I really like how simple the file format is, e.g., https://raw.githubusercontent.com/partyparrot/GitHunt-API-code-tour/master/context.md https://raw.githubusercontent.com/partyparrot/GitHunt-API-co... and the "playlist" file: https://github.com/partyparrot/GitHunt-API-code-tour/blob/master/.codetour.json https://github.com/partyparrot/GitHunt-API-code-tour/blob/ma...