doc/update: Added Compatibility matrix#240
Conversation
✅ Deploy Preview for industrial-experience ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
1307-Dev
changed the title
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new compatibility matrix documentation page for version 5, detailing supported package versions, framework wrappers, and runtime requirements. It also updates the sidebar and the release version page to include links to this new resource. The review feedback highlights several violations of the project's style guide, specifically regarding the use of straight apostrophes instead of the required Unicode symbol, the use of passive voice, and incorrect capitalization of link text. Actionable suggestions were provided to align the documentation with the established grammar and formatting standards.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
There was a problem hiding this comment.
I dont see there any reliable way to keep this up to date without having outdated version. Other point I do not see there any point why this is necessary we have a package.json and npmjs as a registry which provides all necessary information already depending on the version.
If we update peerDependencies between lets say 5.1.0 to 5.2.0 we have always the latest peerDependencies listed here. For 5.1.0 users this information then is leading to a wrong information
There was a problem hiding this comment.
Regarding the versioning, we could consider updating or adding a dedicated page for each sub-version per release. This would allow users to easily navigate between versions, for example, moving from 5.0.0 to 5.1.0, all within the same page.
As for the other point, I'll forward you the email chain where that discussion took place so you have all the context.
2 participants
💡 What is the current behavior?
Compatibility matrix with peer dependencies and version recommendations isn't available.
GitHub Issue Number: #
JIRA Issue-IX-4124
🆕 What is the new behavior?
Added a compatibility matrix
👨💻 Help & support