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

Refactor versioning #1235

Merged
merged 6 commits into from
Oct 19, 2023
Merged

Refactor versioning #1235

merged 6 commits into from
Oct 19, 2023

Conversation

Dr-Electron
Copy link
Collaborator

@Dr-Electron Dr-Electron commented Oct 9, 2023

Description of change

Refactored versioning.

  • Removed defaultVersion. Version are now sorted by order and badge. The fist version of a badge in the list will be the main version
  • Create iota/shimmer redirects for the corresponding main versions

Should be merged after #1226

Links to any relevant issues

Fixes #1204 and #1203

Type of change

  • Enhancement (a non-breaking change which adds functionality)

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own changes
  • I have made sure that added/changed links still work
  • I have commented my code, particularly in hard-to-understand areas

@Dr-Electron Dr-Electron linked an issue Oct 9, 2023 that may be closed by this pull request
@Dr-Electron Dr-Electron changed the base branch from main to fix-redirects October 9, 2023 21:25
@Dr-Electron Dr-Electron marked this pull request as ready for review October 9, 2023 21:36
Base automatically changed from fix-redirects to main October 11, 2023 21:15
@Dr-Electron Dr-Electron mentioned this pull request Oct 12, 2023
4 tasks
Copy link
Collaborator

@lucas-tortora lucas-tortora left a comment

Choose a reason for hiding this comment

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

I think it'll help users know which version to choose at a glance.

Just two notes on my end:

  • If there is no version to choose from, as in the SDK, we should find a way to tell the users that it's for both.
  • We should coordinate the deprecated tags as this looks kind of weird:

image

@Dr-Electron
Copy link
Collaborator Author

I think it'll help users know which version to choose at a glance.

Just two notes on my end:

  • If there is no version to choose from, as in the SDK, we should find a way to tell the users that it's for both.
  • We should coordinate the deprecated tags as this looks kind of weird:

image

I agree on the first point. But maybe that's something Begoña can help with while making the switcher nicer

Second point: I know, but not sure. As one tells you the whole library is deprecated and the other is only about a specific version. So not sure if we can just use version tags 🤔

lucas-tortora
lucas-tortora previously approved these changes Oct 16, 2023
@Dr-Electron Dr-Electron merged commit fa2c4ea into main Oct 19, 2023
11 checks passed
@Dr-Electron Dr-Electron deleted the refactor-versioning branch October 19, 2023 17:04
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.

Simplify version setup Create redirect to default Shimmer version
2 participants