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

Add versioning support to documentation website #6548

Open
jeluard opened this issue Mar 15, 2024 · 2 comments
Open

Add versioning support to documentation website #6548

jeluard opened this issue Mar 15, 2024 · 2 comments
Labels
scope-documentation All issues related to the Lodestar documentation.

Comments

@jeluard
Copy link
Contributor

jeluard commented Mar 15, 2024

  • do we wanna look into adding versioning, or at least show the lasted version here?
    image

Originally posted by @nflaig in #6533 (comment)

@jeluard jeluard added the scope-documentation All issues related to the Lodestar documentation. label Mar 15, 2024
@philknows
Copy link
Member

I do agree with @nflaig comment here about current + a few verions back: #6559 (comment)

If we need a specific number, I doubt people run more than 5 minor versions back.

@jeluard
Copy link
Contributor Author

jeluard commented Apr 5, 2024

Summarizing needs:

  • unstable, referring to unstable branch
  • stable, referring to stable branch
  • some fixed number of versions back

Ideally this should be automated. So any changes in docs in the unstable branch would trigger the update of the documentation website.
Older versions (beyond the specific number we would agree on) should be automatically deleted. Each new version is a complete duplicated folder.
Somehow this process should hook with release process, but not interfere with the unstable docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope-documentation All issues related to the Lodestar documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants