{"repo":"microsoft/codetour","free":true,"listed":false,"github":"https://github.com/microsoft/codetour","clone":"git clone https://github.com/microsoft/codetour.git","description":"VS Code extension that allows you to record and play back guided tours of codebases, directly within the editor.","language":"TypeScript","stars":4566,"topics":["vscode","vscode-extension","knowledge-sharing","code-navigation","onboarding"],"license":"MIT","category":"dev-tools","readme_excerpt":"CodeTour 🗺️ CodeTour is a Visual Studio Code extension, which allows you to record and play back guided walkthroughs of your codebases. It's like a table of contents, that can make it easier to onboard (or re-board!) to a new project/feature area, visualize bug reports, or understand the context of a code review/PR change. A \"code tour\" is simply a series of interactive steps, each of which are associated with a specific directory, or file/line, and include a description of the respective code. This allows developers to clone a repo, and then immediately start learning it , without needing to refer to a CONTRIBUTING.md file and/or rely on help from others. Tours can either be checked into a repo, to enable sharing with other contributors, or exported to a \"tour file\", which allows anyone to replay the same tour, without having to clone any code to do it! Getting Started In order to get started, install the CodeTour extension, and then following one of the following guides, depending on whether you want to record or play back a tour: - Recording Tours - Exporting Tours - Starting Tours - Navigating Tours - Maintaining Tours - Reference Recording Tours If you'd like to record a code tour for your codebase, you can simply click the + button in the CodeTour tree view (if it's visible) and/or run the CodeTour: Record Tour command. This will start the tour recorder, which allows you to begin opening files, clicking the \"comment bar\" for the line you want to annotate, and then addi","default_branch":null,"files":null,"tree":[],"storefront":"/r/microsoft","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/microsoft/codetour/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}