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 the vuejs tutorial #7890

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

MooseSaeed
Copy link

@MooseSaeed MooseSaeed commented Dec 24, 2024

This pull request includes updates to the Vue.js tutorial documentation in Visual Studio Code. The changes focus on updating extension recommendations, improving clarity, and ensuring the tutorial content is current.

Vue 2 Support:

  • Changed the Vue 2 Support note to past tense to reflect that it has ended.

Extension Recommendations:

  • Updated references to the "Vue - Official" extension, previously known as Volar.

Vue CLI Reference:

  • Removed the reference to vue-cli-service as Vue CLI is no longer recommended for new apps and isn't relevant to the tutorial.
  • Added information about Vite's Hot Module Replacement feature.

Tutorial Content:

  • Clarified instructions for running the Vue application and removed redundant steps.
  • Enhanced the "Go to Definition" and "Peek Definition" sections to provide clearer instructions on using these features.
  • Removed unnecessary step to restart the dev server, as Vite's HMR automatically applies the changes.

Debugging and Linting:

  • Updated links for the Vue ESLint plugin and Vue Devtools to provide users with the latest official resources.

Screenshots:

  • Updated screenshots for the recommended extensions, but the preview in the PR's "Files Changed" tab isn't working.

Helpful External Link:

  • Added a link to a video tutorial on using the Vue - Official extension in VS Code.

Updated outdated information and improved readability for clarity and accuracy.
@MooseSaeed MooseSaeed changed the title Update vuejs-tutorial.md Update the vuejs tutorial Dec 24, 2024
Copy link
Contributor

@ntrogh ntrogh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MooseSaeed Thanks for updating the Vue.js tutorial. Looks good except for the linking to third-party learning content.


## Other extensions

Volar is only one of many Vue.js extensions available for VS Code. Another recommended extension is [Volar for TypeScript](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
[Vue - Official extention](https://vueschool.io/lessons/volar-the-official-language-feature-extension-for-vs-code) is only one of many Vue.js extensions available for VS Code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: extention => extension

Suggest using the Marketplace URL for the extension. We don't usually link to third-party learning content from our docs unless they're part of the core product. So, it's fine to link to vuejs.org content.

@ntrogh ntrogh added the doc-enhancement suggested addition or improvement label Jan 2, 2025
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 this pull request may close these issues.

2 participants