Skip to content

docs: add versioning to docs#252

Open
Sky-walkerX wants to merge 4 commits intofedimint:mainfrom
Sky-walkerX:addVersioningToDocs
Open

docs: add versioning to docs#252
Sky-walkerX wants to merge 4 commits intofedimint:mainfrom
Sky-walkerX:addVersioningToDocs

Conversation

@Sky-walkerX
Copy link
Copy Markdown
Contributor

@Sky-walkerX Sky-walkerX commented Mar 10, 2026

It adds the versioning feature to the docs using vitepress-versioning-plugin as well as took the snapshot of current docs into 0.1.x directory, also converts the sidebar for multi version support accordingly.
Closes #168

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 10, 2026

⚠️ No Changeset found

Latest commit: 1074c68

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Sky-walkerX Sky-walkerX force-pushed the addVersioningToDocs branch from 758612a to 1074c68 Compare March 10, 2026 15:35
@Sky-walkerX Sky-walkerX changed the title Add versioning to docs docs: add versioning to docs Mar 10, 2026
Copy link
Copy Markdown
Member

@alexlwn123 alexlwn123 left a comment

Choose a reason for hiding this comment

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

Nice. Since there's only one version, it just redirects to the base path without a version. Can you add another (legacy) version, even just for testing, to show what it looks like to navigate to the old docs?

Also, I don't love how the vitepress version plugins requires us to copy over every file from the doc site for every new version... I'm wondering if we could have a section of live/evergreen docs and just just track any "old"/"legacy" docs between versions. Let me know if you have any ideas.

@Sky-walkerX
Copy link
Copy Markdown
Contributor Author

Okay, I'll try to do that.

@socket-security
Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednpm/​cross-spawn@​7.0.6991009780100
Addednpm/​css-loader@​7.1.49810010087100

View full report

@Sky-walkerX
Copy link
Copy Markdown
Contributor Author

Sky-walkerX commented Mar 20, 2026

Added some legacy docs as asked.

. I'm wondering if we could have a section of live/evergreen docs and just just track any "old"/"legacy" docs between versions. Let me know if you have any ideas.

I explored and got to know that we can use git branches to manage docs. whenever we do a major change, we can make new branch and rest of the thing can be handled by hosting provider.

@Sky-walkerX Sky-walkerX requested a review from alexlwn123 March 28, 2026 22:02
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.

Add Versioning to Docs

2 participants