You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Feat: Support Multiple Versions of Fury Documentation
📝 Summary
This PR introduces support for versioned documentation in the Fury site, enabling the project to maintain and display multiple versions of documentation simultaneously (e.g., latest, 0.10.0, etc). This is particularly useful as the project evolves, allowing users to reference docs for the version they are using.
🔧 Changes Introduced
Enabled Docusaurus versioning feature.
Created initial versioned documentation for v0.10.0 using:
yarn run docusaurus docs:version 0.10.0
Directory structure updated to include:
versioned_docs/version-0.10.0/
versioned_sidebars/version-0.10.0-sidebars.json
versions.json
Added basic routing and navigation support for switching between versions in the docs UI.
📁 Affected Files
docusaurus.config.js: No major changes needed, but future versions may modify the default version or UI options.
New files/folders added:
versioned_docs/
versioned_sidebars/
versions.json
✅ Benefits
Users can easily access and compare documentation for multiple versions of Fury.
Prevents breaking changes in documentation from affecting users on older versions.
Lays the groundwork for future versioned releases (e.g., v0.11.0, v1.0.0, etc).
🧪 How to Test
Run the local dev server:
yarn start
Navigate to the documentation section.
Use the version dropdown in the top-right corner to switch between latest and 0.10.0.
Ensure that switching versions loads the correct versioned content.
📌 Notes
The 0.10.0 version was generated from the current state of the docs/ directory.
We don't have to keep a version for every fix release. We could only provide doc for every major.minor version of fury
+1
It is good for me to manage multi doc versions by yarn run docusaurus docs:version xxx.
But it's unnecessary to keep independent docs for minor versions. since the vesions before 1.0 are unstable,
This file contains hidden or 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
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.
Feat: Support Multiple Versions of Fury Documentation
📝 Summary
This PR introduces support for versioned documentation in the Fury site, enabling the project to maintain and display multiple versions of documentation simultaneously (e.g.,
latest,0.10.0, etc). This is particularly useful as the project evolves, allowing users to reference docs for the version they are using.🔧 Changes Introduced
v0.10.0using:versioned_docs/version-0.10.0/versioned_sidebars/version-0.10.0-sidebars.jsonversions.json📁 Affected Files
docusaurus.config.js: No major changes needed, but future versions may modify the default version or UI options.versioned_docs/versioned_sidebars/versions.json✅ Benefits
v0.11.0,v1.0.0, etc).🧪 How to Test
latestand0.10.0.📌 Notes
0.10.0version was generated from the current state of thedocs/directory.🤝 Related