docs: versioning for documentation #1704
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jarinox
changed the title
jarinox
force-pushed
the
feat/vitepress-versioning
branch
from
5999c54
to
919233c
Compare
added 4 commits
February 28, 2024 16:14
- refactor sidebar as plugin requires sidebars to strictly conform with the specs
The versioning plugin only works with relative links as absolute links would always point to the latest version. See IMB11/vitepress-versioning-plugin#2
Sidebars have to be defined for each version. This adds a JSON file which can be copied to create set the current sidebar to future versions.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request Checklist
have been resolved.
[Unreleased] heading.
along with a short description of what it is for, and documented this in the Pull Request (below).
(at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
importer etc.), I have generated longer distance routes for the affected profiles with different options
(avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
points generated from the current live ORS.
If there are differences then the reasoning for these MUST be documented in the pull request.
and why the change was needed.
Fixes # .
Information about the changes
This adds the vitepress-versioning-plugin and refactors the docs to work together with this plugin. All absolute internal links have been changed to relative links. The vitepress configuration has been updated to work with this plugin.
How to add a new version
docs/versions/{lastVersion}and copy the documentation of the last version into it.cp docs/.vitepress/sidebars/versioned/template.json docs/.vitepress/sidebars/versioned/{lastVersion}.jsonto create a sidebar for the new version. Manually change the sidebar if needed.