codetour

Somewhat related (and seems like a lot of folks don't know about) is VS Code's "Code Tour" feature: https://github.com/microsoft/codetour The best part is the ability to easily edit, delete, and re-order "tour points". Tours can either be checked into the repo or exported to a "tour file" to allows anyone to replay the same tour (without having to clone any code to do it!)

Regarding the @next, i found the best way to get back into a session after being interrupted, was watching yourselve working on the code. https://github.com/microsoft/codetour Basically record the last 5 minutes of your work and replay as code tour.

The description here reminded me of CodeTour https://github.com/vsls-contrib/codetour > CodeTour is a Visual Studio Code extension, which allows you to record and playback guided walkthroughs of your codebases.

without CodeTour needing to do anything about it, you can just use git and name CodeTour based on git tag, hash or something. Edit: It actually can reference a git ref, WOW: https://github.com/microsoft/codetour#versioning-tours

Whenever I onboard to a new codebase, or try to learn more about an open-source project, I typically create personal notes that outline the structure and high-level “markers” that I want to remember and easily reference later. Unfortunately those notes are disconnected from the codebase itself, and therefore, not as immersive/rich as I wanted them to be. So I created a tool that allows me to annotate codebases with my own walkthroughs/breadcrumbs/ToCs and then play them back at any time, directly within my editor. This workflow has provided a pretty nice productivity boost for me thus far, and has the benefit of enabling me to share these walkthroughs with others as well: https://github.com/vsls-contrib/codetour.

Woah. The tour markers feature was really unexpected, that's a really clever approach. Great work! https://github.com/vsls-contrib/codetour/blob/master/README....

Thanks! If you get a chance to check it out, please don’t hesitate to send any feedback my way. I need all the help I can get in order to ensure this experience is awesome :) https://github.com/vsls-contrib/codetour

Great question! I’m not currently sure :) I’ve been fairly deliberate about building CodeTour in a language agnostic way, in order to ensure it could be applied to any file type within a codebase. This is partly why I haven’t based the tour definition experience on code comments: https://github.com/vsls-contrib/codetour/issues/38. That said, I’m trying to keep an open-mind when it comes to increasing tour resiliency, since it may require language/platform-specific solutions. I’m not sure. If you had any thoughts, I’d love to hear them! Another potential solution is to have a CI task, that could check to see how far the code has deviated from the original commit that the tour was recorded on, and notify you when the deviation crosses some threshold. Maybe that’s a terrible idea, but something like that would have the benefit of being langu

I’ve never built any tooling for Vim, but I’m really inspired by the challenge :) Thanks for the suggestion, and stay tuned! Note: If anyone’s reading this, and has experience in Vim “extensibility”, I’d like to collaborate: https://github.com/vsls-contrib/codetour

Oh cool! Yeah, we are definitely kindred spirits :) I wanted to start with VS Code (in order to scratch my own itch), but I’m now working on a browser “player” and looking into GitHub integration (https://github.com/vsls-contrib/codetour/issues/10). I love seeing other folks investing in this space. Thanks for sharing!

Thanks! I’m keen to explore integration with GitHub in the near future (https://github.com/vsls-contrib/codetour/issues/10), in order to provide a browser-based “player”. That way, the knowledge in the tour isn’t limited to any one editor. That said, I wanted to record the tours in a simple JSON file, specifically to enable interop with other tools. I’d love to hear any feedback you have on the experience and/or the format!