docs: add versioning to docs - #252
Sky-walkerX wants to merge 4 commits into
Conversation
|
758612a to
1074c68
Compare
alexlwn123
left a comment
There was a problem hiding this comment.
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.
|
Okay, I'll try to do that. |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Added some legacy docs as asked.
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. |
|
@fedimint-bot review |
fedimint-bot
left a comment
There was a problem hiding this comment.
Review findings
docs/.vitepress/sidebar.ts:50- warning: this reverts the current live sidebar entry fromCreating a wallet/createWalletback tonew FedimintWallet()/constructor. Currentmainhas moved the public docs tocreateWallet, so after the conflict is resolved this should preserve the new page instead of reintroducing the older constructor link.docs/.vitepress/sidebar.ts:158- warning: the currentFederationServicesidebar entries forgetEventLog()andgetMetaConsensusValue()are lost here. Please carry those links and their docs forward for the latest version when rebasing, otherwise the versioned docs change will hide existing current API pages from navigation.docs/.vitepress/config.ts:21- warning: currentmainconfigurestransformerTwoslashwith bundler/ESNext compiler options. This PR resets it totransformerTwoslash()with no options, which risks bringing back the docs type-resolution issue that config was added to fix. Please preserve the current options inside the versioned config wrapper.
Validation
pnpm install --frozen-lockfilepassed.pnpm --filter docs docs:buildpassed on this PR branch.- GitHub reports the PR as merge-conflicting, so I could not validate the post-rebase result against current
main.
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