Eliminate navigation duplication between navbar and sidebar configurations #1280
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the duplicate navigation information between the navbar and sidebar configurations, which was causing maintenance overhead and potential inconsistencies.
Problem
The documentation site had duplicate navigation structures defined in two separate files:
/main/.vitepress/themeConfig/nav.js
(navbar configuration) - 218 lines/main/.vitepress/config.mjs
(sidebar configuration) - 500+ linesThis duplication meant:
Solution
Created a shared navigation configuration system that eliminates duplication while preserving all existing functionality:
1. Shared Navigation Source (
shared-nav.js
)2. Simplified Navbar (
nav.js
)3. Dynamic Sidebar Generation (
config.mjs
)Benefits
Testing
Files Changed
/main/.vitepress/themeConfig/shared-nav.js
- Shared navigation configuration/main/.vitepress/themeConfig/nav.js
- Simplified to use shared config/main/.vitepress/config.mjs
- Updated to use dynamic sidebar generation/main/.vitepress/package.json
- Updated module type for ES modulesThe solution maintains backward compatibility while significantly improving the maintainability and consistency of the documentation site's navigation system.
Fixes #1230.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.