Skip to content

fix: Versions in docs (fix #1532) #3930

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

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

yash-dayama
Copy link

@yash-dayama yash-dayama commented Jul 31, 2025

Title: fix: Versions in docs (fix #1532)

Description:

This PR adds version information to the Vue Router documentation to help users understand which version of the documentation is available in their preferred language. This addresses issue #1532 where users had no way of knowing if their language's documentation was up to date with the latest features.

Changes made:
- Updated config.js to include version information in language labels
- Added version tracking fields for each language
- Added version information tips to each language's README.md:
  - English (Up to v2.6)
  - French (Up to v2.5)
  - Japanese (Up to v2.4)
  - Chinese (Up to v2.3)
  - Russian (Up to v2.1)
  - Korean (Up to v2.0)

This helps users by:
- Clearly showing which version each translation covers
- Making it easy to see if a specific feature is documented in their language
- Helping users decide whether to use English docs for newer features

Implementation:
- Added version information to language selector in the navigation
- Added prominent version notices at the top of each language's main documentation
- Maintained consistent formatting across all languages
- Preserved all existing documentation content and structure

Testing:
- Verified version information appears correctly in language selector
- Confirmed version tips display properly in all language versions
- Checked formatting and layout consistency across all pages

This implements the solution proposed in the original issue while maintaining the documentation's clean and professional appearance.

Copy link

netlify bot commented Jul 31, 2025

Deploy Preview for vue-router-docs-v3 ready!

Name Link
🔨 Latest commit 1f0f8b3
🔍 Latest deploy log https://app.netlify.com/projects/vue-router-docs-v3/deploys/688af5fd959e5a00081f1a39
😎 Deploy Preview https://deploy-preview-3930--vue-router-docs-v3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

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.

1 participant