Skip to content

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 9 commits into from
Dec 10, 2020
Merged

Add CodeTour #2412

merged 9 commits into from
Dec 10, 2020

Conversation

bpmct
Copy link
Member

@bpmct bpmct commented Dec 7, 2020

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.

code-server 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!

@bpmct bpmct requested a review from code-asher December 7, 2020 14:50
@bpmct bpmct requested a review from nhooyr as a code owner December 7, 2020 14:50
@code-asher
Copy link
Member

Looking good! I'll push up some additions between today/tomorrow.

@bpmct
Copy link
Member Author

bpmct commented Dec 9, 2020

@code-asher I added some minor changes, fixed the filesystem thing, and added a development tour. Let me know what you think!

bpmct and others added 4 commits December 9, 2020 22:02
`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 code-asher merged commit 9efdec8 into coder:master Dec 10, 2020
@nhooyr
Copy link
Contributor

nhooyr commented Dec 14, 2020

Thanks @bpmct 🔥

@nhooyr nhooyr added this to the v3.8.0 milestone Dec 18, 2020
@bpmct bpmct deleted the codetour branch December 19, 2020 04:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants