Skip to content

Documentation using modules #829

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

Closed
posva opened this issue Mar 15, 2021 · 6 comments
Closed

Documentation using modules #829

posva opened this issue Mar 15, 2021 · 6 comments
Labels
discussion This problem still needs more feedback docs Concerns the documentation content or the documentation website

Comments

@posva
Copy link
Member

posva commented Mar 15, 2021

Right now the starting guide (https:/router.vuejs.org/guide/) still uses a vanilla index.html approach. I think that it was easier back when vue-router started but now it isn't anymore and that maybe that page should be updated using .vue components and pointing to vue CLI and vite. It should maybe also point to Vue docs explaining Vue files.

What are your thoughts on this?

Do you have any other ideas on how to restructure this section of the docs?

@posva posva added discussion This problem still needs more feedback docs Concerns the documentation content or the documentation website labels Mar 15, 2021
@Ziqi418
Copy link

Ziqi418 commented Apr 4, 2021

https://www.vuemastery.com/blog/vue-router-a-tutorial-for-vue-3/
Found an example about how to use router in Vite.

@ionous
Copy link

ionous commented Feb 3, 2022

starting a new vue3 + vite project, one thing that confused me was how to import the router in order to use the code from the getting started page. ( import * as VueRouter from 'vue-router seems to do the trick. )

the previous version's installation page had an example import statement, and that was a nice help.

@daniel-farina
Copy link

This was really painful, not having the imports needed for the examples on the router was quite confusing.

@thedamon
Copy link

thedamon commented Jan 9, 2024

There have been several PRs to fix this rather obvious fault in the docs.. what do we need to do to get one in?

#1951
#1769
#1323
#1037

@posva
Copy link
Member Author

posva commented Jan 10, 2024

@thedamon Most of them were actually incorrectly importing the router. It was better not to spread bad practices. Currently I need to focus on other stuff before getting back to the documentation, so feedback on difficult parts is welcome: #2068
BTW, #1323 is the one that was the closest to what the page should look like but the author closed it probably because It's been 2 years

@skirtles-code
Copy link
Contributor

The examples have been updated by #2174.

I think this issue can be closed.

@posva posva closed this as completed Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion This problem still needs more feedback docs Concerns the documentation content or the documentation website
Projects
None yet
Development

No branches or pull requests

6 participants