Skip to content

Feat: Support multiple version of fury document#216

Closed
LofiSu wants to merge 4 commits into
apache:mainfrom
LofiSu:main
Closed

Feat: Support multiple version of fury document#216
LofiSu wants to merge 4 commits into
apache:mainfrom
LofiSu:main

Conversation

@LofiSu
Copy link
Copy Markdown
Contributor

@LofiSu LofiSu commented Apr 8, 2025

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

  1. Run the local dev server:
    yarn start
  2. Navigate to the documentation section.
  3. Use the version dropdown in the top-right corner to switch between latest and 0.10.0.
  4. 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.
  • Future versions can be added using:
    yarn run docusaurus docs:version <new-version>

🤝 Related

@chaokunyang
Copy link
Copy Markdown
Contributor

We don't have to keep a version for every fix release. We could only provide doc for every major.minor version of fury

@theweipeng
Copy link
Copy Markdown
Member

theweipeng commented Apr 14, 2025

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,

@PragmaTwice
Copy link
Copy Markdown
Member

We don't have to keep a version for every fix release. We could only provide doc for every major.minor version of fury

as long as we promise that patch version will never bring breaking changes.

@theweipeng
Copy link
Copy Markdown
Member

docusaurus alreay supports configuring multiple versions. It's not too late to generate multiple versions after we have the release version 1.0.

@theweipeng theweipeng closed this May 20, 2025
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.

4 participants