Skip to content
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

Update overall getting started experience #7359

Closed
3 of 5 tasks
Tracked by #7426
ntrogh opened this issue Jun 7, 2024 · 5 comments · Fixed by #7588
Closed
3 of 5 tasks
Tracked by #7426

Update overall getting started experience #7359

ntrogh opened this issue Jun 7, 2024 · 5 comments · Fixed by #7588
Assignees
Labels
doc-enhancement suggested addition or improvement
Milestone

Comments

@ntrogh
Copy link
Contributor

ntrogh commented Jun 7, 2024

Improve the overall getting started docs experience for new users.

  • Review getting started documentation section and
  • Create an outline for a guided getting started experience.
  • Create Getting Started tutorial
  • Update docs landing page and CTAs
  • Evaluate how we can align the in-product walkthroughs with the Getting Started tutorial.
@ntrogh ntrogh added this to the June 2024 milestone Jun 7, 2024
@ntrogh ntrogh self-assigned this Jun 7, 2024
@ntrogh ntrogh added the doc-enhancement suggested addition or improvement label Jun 7, 2024
@ntrogh
Copy link
Contributor Author

ntrogh commented Jun 25, 2024

Outline for Getting Started tutorial. The objective is to take a user through a guided tour of the key features of VS Code.

  • Open a workspace
    • Create a new folder
    • Open folder in VS Code
    • Explain concept of workspace
  • Learn about the user interface
    • Activity Bar + views
    • Editor
    • Panel (mention integrated terminal)
    • Command Palette
  • Edit a code file
    • Create app.js file
    • Intro to IntelliSense
    • Enable auto save
    • Create a Python file -> no IntelliSense
  • Install a language extension
    • Install Python extension -> IntelliSense, Debugging, Testing, ...
    • Many other extensions available (themes, ...)
  • Run your code
    • Make sure Node is installed
    • Open integrated terminal > node app.js
    • Use F5 to use built-in debugging capabilities
  • Customize VS Code
    • Appearance -> change color theme
    • Settings -> Font Size
    • Much more, such as keybindings, ...
  • Next steps
    • Tips & tricks
    • Edit basics
    • Source control
    • Integrated terminal
    • Debugging
    • Testing

@bhavyaus here's a first draft of the outline for the VS Code getting started tutorial. Do you see any key topics that are missing for someone's first experience with VS Code?

@ntrogh
Copy link
Contributor Author

ntrogh commented Jun 26, 2024

@bamurtaugh sharing the draft outline for a VS Code Getting Started tutorial. Any feedback is welcome!

@bhavyaus
Copy link
Collaborator

  1. Should Customize VS Code section appear right after the Learn about the user interface section? Past user studies suggest that offering some level of customization at the start of user interactions tends to result in sustained engagement -> the first step in the getting started walkthrough is "Choose your theme".
    @daviddossett might have more info here.

  2. Install a language extension should be before Edit a code file so that users can edit and run the code in the language of their choice.

@ntrogh
Copy link
Contributor Author

ntrogh commented Jun 28, 2024

@bhavyaus thanks for the feedback. I'll incorporate it.

@bamurtaugh
Copy link
Member

Thanks for putting this together, looks great!

I think it could be interesting incorporate Remote Development and GitHub Copilot, maybe as Next Steps? They could become fundamental to how users develop with VS Code everyday, so I think they could make sense to highlight somewhere in a getting started.

@femenza femenza mentioned this issue Jul 2, 2024
@ntrogh ntrogh changed the title Create outline for the overall getting started experience Update overall getting started experience Jul 8, 2024
@ntrogh ntrogh modified the milestones: June 2024, August 2024 Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-enhancement suggested addition or improvement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@ntrogh @bhavyaus @bamurtaugh and others