-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Add CodeTour #2412
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add CodeTour #2412
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Looking good! I'll push up some additions between today/tomorrow. |
@code-asher I added some minor changes, fixed the filesystem thing, and added a development tour. Let me know what you think! |
`file` doesn't seem to work without a specific git reference, but adding a reference makes the explorer not follow the tour. Unfortunately `directory` doesn't show the directory contents so I added the directory name and "see the explorer" to the comment.
For now it has to be a full link but in the future it would be nice to open it relatively in the editor.
code-asher
approved these changes
Dec 10, 2020
Thanks @bpmct 🔥 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The CodeTour extension for VS Code gives users an interactive walkthrough of a codebase.
When the repo is first cloned (and the CodeTour extension is installed), a dialog appears with the option to start a tour.
Tours can be viewed, edited, and "recorded" with the extension, or through editing the
.tour
file. I have created a a basic tour, but would love input from @code-asher and others on what areas of codebase to point new contributors to.Since code-server is well-documented, perhaps this can be used as a way to show people what files are important. CodeTours can also prompt users to execute shell commands. This could be used to help with onboarding or to run tests for the first time!