LofiSu opened a new pull request, #216:
URL: https://github.com/apache/fury-site/pull/216
## 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:
```bash
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:
```bash
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:
```bash
yarn run docusaurus docs:version <new-version>
```
---
### ๐ค Related
- link to : https://github.com/apache/fury-site/issues/215
- ๐ Documentation reference: [[Docusaurus
Versioning](https://docusaurus.io/docs/versioning)](https://docusaurus.io/docs/versioning)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
