-
-
Notifications
You must be signed in to change notification settings - Fork 306
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
chore: prepare for docs versioning #6559
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## unstable #6559 +/- ##
=========================================
Coverage 61.39% 61.39%
=========================================
Files 556 556
Lines 58751 58751
Branches 1848 1848
=========================================
Hits 36073 36073
Misses 22638 22638
Partials 40 40 |
docs/docusaurus.config.ts
Outdated
lastVersion: 'current', | ||
versions: { | ||
current: { | ||
label: '1.7.0' |
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.
shouldn't this match whats in our packages/cli/package.json?
What is the process for synchronizing this?
My bad, my intention was to match the repo versions. Ideally the latest version would be updated via the release scripts. It's not clear to me when we would want to introduce a new doc version. FWIW, introducing a new doc version requires duplicating the whole doc content in a specific repo (a script can help this process) Maybe @nflaig can shim in, as was interested with the versioning support. |
The idea was to have something similar to what teku does https://docs.teku.consensys.io/. We could always build docs from unstable branch (on each commit), have docs from stable branch as default as we do now, and then just a few previous releases back.
Previous docs bundle would have to be hosted somewhere, maybe this is possible via github pages, or another source is required. Might wanna check out how teku does it https://github.com/Consensys/doc.teku |
Sorry I meant in a specific folder, it's fine in current repo/gh-pages hosting. So the repo would ultimately contain multiple copies of the whole documentation, with just a couple changes (see how it looks like for teku). Maybe we can decide to not introduce doc version per lodestar release, but only introduce new doc version when significant docs changes have been introduced. |
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.
Will this just show the latest version for now?
@@ -0,0 +1 @@ | |||
[] |
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.
[] | |
[] | |
Closing for now. Will address once we have a better idea of what we want. |
Motivation
Prepare for future versioning. For now only support one version, and display it in the main toolbar.
Fixes #6548