search

microsoft / codetour

VS Code extension that allows you to record and play back guided tours of codebases, directly within the editor.
https://aka.ms/codetour
MIT License
4.36k stars 113 forks source link

Allow marking main tour #60

Closed gracegtaylor closed 4 years ago

gracegtaylor commented 4 years ago

What if we implement some way for certain tours to be "starred" by default or shown as higher importance? Or, a tagging/categorization mechanism? That way, a new dev onboarding to the codebase will know right away what is most important to view first.

lostintangent commented 4 years ago

We’ve already got #50 tracking the ability to group/categorized tours into directories. Should we make this specific to being able to star tours? If so, is the “Star” set by the owner of the repo, or is that something that the individual dev can do?

gracegtaylor commented 4 years ago

What if we implement default "stars" and then ability for personal customizations?

lostintangent commented 4 years ago

I just renamed this issue, since I think we should use it to track the ability to mark a tour in a codebase as being the “main” tour. This would have two key benefits:

  1. When a new user opens the codebase, and are presented with the option to take a tour, they’d be immediately guided to the the “main” tour as opposed to displaying the entire list of tours. That way the onboarding experience could be more prescriptive

  2. The “main” tour would be visually differentiated in the CodeTour tree (e.g. a unique icon)

RandomFractals commented 4 years ago

also, don't let them open the other code tours till they are done with the main one. just kidding

lostintangent commented 4 years ago

Support for this has now been shipped. You can simply right-click a tour in the CodeTour tree and select Make Primary.