ingonyama-zk / icicle

A hardware acceleration library for compute intensive cryptography :ice_cube:
https://dev.ingonyama.com/icicle/overview
MIT License
339 stars 105 forks source link

[Docs]: Update docusaurus to latest and add versioned docs #661

Open jeremyfelder opened 1 day ago

jeremyfelder commented 1 day ago

Describe the changes

This PR adds versioning to our dev docs. Currently supporting docs for versions 1.10.1, 2.8.0, 3.0.0, and 3.1.0.

Things to note

  1. All versioned docs are under the directory docs/versioned_docs each version with their own docs.
  2. Each version also has its own sidebar in json format under docs/versioned_sidebars.
  3. A versions file containing all versions that will be shown on the site is found in docs/versions.json
  4. Moved to using typescript for better typing readability.
  5. Creating a release now bumps the docs as well and will automatically create the correct versioned docs
  6. The docs under docs/docs are considered to be the next versions docs and are a WIP and are not published
yshekel commented 1 day ago

awesome!!