Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 6 commits into from
Nov 24, 2024

Conversation

jeremyfelder
Copy link
Collaborator

@jeremyfelder jeremyfelder commented Nov 21, 2024

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
Copy link
Collaborator

yshekel commented Nov 21, 2024

awesome!!

@vhnatyk vhnatyk self-requested a review November 21, 2024 19:42
Copy link
Contributor

@vhnatyk vhnatyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

@jeremyfelder jeremyfelder merged commit 71ec004 into main Nov 24, 2024
30 checks passed
@jeremyfelder jeremyfelder deleted the docs/update-docusaurus-and-versioning branch November 24, 2024 07:55
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.

3 participants