Skip to content

docs: rewrite the Named Routes page #2176

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 2 commits into from
Mar 16, 2024
Merged

Conversation

skirtles-code
Copy link
Contributor

There are several problems I was trying to address:

  1. Named routes are used in earlier pages, particularly the Nested Routes and Programmatic Navigation pages, which use them quite heavily.
  2. The list of advantages comes too soon. A reader will struggle to understand that list until they have seen the example.
  3. Advantage 2 on the list mentions encoding/decoding. As far as I can tell, that should just be encoding, as named routes don't impact decoding.
  4. Advantage 4 stops mid-sentence. Bypassing path ranking (e.g. to display a ).
  5. The linked example is for Vue 2.

While I've reworded and reordered much of the page, the material covered should be the same.

I've tweaked the example to use name: 'profile', rather than name: 'user'. This was to avoid the name coinciding with the /user/ prefix on the path. These kinds of naming coincidences can (in general) lead to beginners misunderstanding what is significant and what isn't, and it seemed unnecessary to risk any confusion here.

Copy link

netlify bot commented Mar 16, 2024

Deploy Preview for vue-router ready!

Name Link
🔨 Latest commit 4ba8751
🔍 Latest deploy log https://app.netlify.com/sites/vue-router/deploys/65f5f4f933964900082316ca
😎 Deploy Preview https://deploy-preview-2176--vue-router.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 97 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@posva posva left a comment

Choose a reason for hiding this comment

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

Nice! Thanks a lot

@posva posva merged commit 837a5e8 into vuejs:main Mar 16, 2024
niceplugin added a commit to niceplugin/Vuejs-Router-KO that referenced this pull request Mar 17, 2024
niceplugin added a commit to niceplugin/Vuejs-Router-KO that referenced this pull request Mar 17, 2024
* docs: update examples to use SFCs (vuejs#2174)

* docs: rewrite the Named Routes page (vuejs#2176)
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.

2 participants