-
-
Notifications
You must be signed in to change notification settings - Fork 4.5k
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
feat(website): enable docs versioning #5676
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about calling it stable
instead of v1
? Once we release v2, the docs will then be available as stable
, 1.x
and next
.
Also, how will the docs be updated when releasing a new version? |
Thanks for working on this @ikatyang and for cc-ing me! I don't have any experience with docusaurus or publishing several doc versions at once, so unfortunately can't express any useful opinion here. If using a single master branch and multi-versioned docs works well as multiple branches we were discussing in #5671, I'm happy with this decision. |
Co-Authored-By: ikatyang <[email protected]>
Based on the discussion in #5671, I think it should be better to be in this form:
This PR aims to address stable and next minor, the major ones should be handled in v2. |
|
Fixes #5362 (by upgrading docusaurus)
Unblock #5674
v1 docs are generated by
yarn docusaurus-version v1
, which enables the docs versioning and copies the current docs to the v1 folder. We just need to run it again to sync the current docs and thenext
docs before releasing a new version.cc @kachkaev
docs/
directory)✨Try the playground for this PR✨