-
Notifications
You must be signed in to change notification settings - Fork 323
Add version compatibility matrix to SDKs docs #2993
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
Open
atharvadeosthale
wants to merge
3
commits into
main
Choose a base branch
from
sdk-compatibility
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+170
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The footnote states "The SDK versions in its row are the latest at that publish date and target the
1.8.xline, so they may not be fully compatible with the1.7.xAPI." However, the data in the1.7.5rows (both Client and Server tables) is identical to the1.7.4rows — pre-1.8.0SDK versions — not the1.8.x-era versions that appear in the1.8.0row. The PR description also says "its row reflects1.8.x-targeted SDKs" which likewise does not match the tabulated data.As a result, the closing advice — "prefer the SDKs listed in the
1.7.4row" — is a no-op: both rows carry exactly the same pins. A reader trying to decide which SDKs to install for their1.7.5server will be told these versions may break compatibility, then discover the "safer" alternative is identical. Either the1.7.5matrix data should be updated to show the actual1.8.x-era SDK versions that were current when1.7.5shipped, or the footnote text needs to be corrected to accurately describe what the row contains.