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.
There was a problem hiding this comment.
@danielleroux How do we proceed with this PR?
📝 WalkthroughWalkthroughA new Version 5 compatibility matrix documents supported packages, frameworks, integrations, runtimes, and CI-tested versions. The page is added to the Releases sidebar, and release documentation updates its linked label. ChangesVersion 5 compatibility documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/home/releases/compatibility-v5.md`:
- Line 9: Update the V5 release metadata in the compatibility-v5 page to match
the release-version page: set the status to Latest and replace the approximate
May 2026 date with the confirmed July 21, 2026 release date.
- Line 38: Update the TypeScript compatibility entry to use one unambiguous
semver range format, replacing the mixed “~5.4 – ~5.8” notation with either
“>=5.4 <5.9” or “5.4–5.8”.
In `@docs/home/releases/release-version.md`:
- Around line 54-55: Remove the duplicate compatibility-matrix sentence, retain
a single sentence after the table, and insert a blank line before it so Markdown
parses the table correctly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 03c9a17d-033f-40fd-9584-d38d03b92ecc
📒 Files selected for processing (3)
docs/home/releases/compatibility-v5.mddocs/home/releases/release-version.mdsidebars.ts
|
|
||
| # Compatibility matrix | ||
|
|
||
| **Status:** Next · **Released:** ~ May 2026 |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Update the V5 release status.
This page says Status: Next, but docs/home/releases/release-version.md identifies V5.0.0 as Latest with a May 2026 release. As of July 21, 2026, the status and release date should be consistent across both pages.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/home/releases/compatibility-v5.md` at line 9, Update the V5 release
metadata in the compatibility-v5 page to match the release-version page: set the
status to Latest and replace the approximate May 2026 date with the confirmed
July 21, 2026 release date.
| | Requirement | Version | | ||
| | --- | --- | | ||
| | Node.js | 22.x | | ||
| | TypeScript | ~5.4 – ~5.8 | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
sed -n '1,120p' docs/home/releases/compatibility-v5.md
printf '\n---\n'
rg -n "TypeScript|~5\.4|<5\.9|5\.4–5\.8|5\.4 - 5\.8|>=5\.4" docs -g '*.md'Repository: siemens/ix-docs
Length of output: 1419
🏁 Script executed:
rg -n "TypeScript \| ~|TypeScript \|.*5\.[0-9]" docs/home docs -g '*.md'Repository: siemens/ix-docs
Length of output: 295
Clarify the TypeScript range syntax. ~5.4 – ~5.8 mixes tilde and interval notation, which is easy to misread. Use a single semver form like >=5.4 <5.9 or 5.4–5.8.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/home/releases/compatibility-v5.md` at line 38, Update the TypeScript
compatibility entry to use one unambiguous semver range format, replacing the
mixed “~5.4 – ~5.8” notation with either “>=5.4 <5.9” or “5.4–5.8”.
| For detailed framework and dependency requirements per package, see the [compatibility matrix](compatibility-v5.md). | ||
| For detailed framework and dependency requirements per package, see the [Compatibility matrix](compatibility-v5.md). No newline at end of file |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Remove the duplicate link and separate it from the table.
Both sentences are present, and without a blank line Markdown parsers treat them as malformed table rows. Keep one sentence after the table with a blank line before it.
Proposed fix
| V2.0.0 | End of life | September 2023 | May 2025 | November 2025 |
+
-For detailed framework and dependency requirements per package, see the [compatibility matrix](compatibility-v5.md).
For detailed framework and dependency requirements per package, see the [Compatibility matrix](compatibility-v5.md).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For detailed framework and dependency requirements per package, see the [compatibility matrix](compatibility-v5.md). | |
| For detailed framework and dependency requirements per package, see the [Compatibility matrix](compatibility-v5.md). | |
| | V2.0.0 | End of life | September 2023 | May 2025 | November 2025 | | |
| For detailed framework and dependency requirements per package, see the [Compatibility matrix](compatibility-v5.md). |
🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 54-54: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
[warning] 54-54: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
[warning] 54-54: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
[warning] 55-55: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing leading pipe
(MD055, table-pipe-style)
[warning] 55-55: Table pipe style
Expected: leading_and_trailing; Actual: no_leading_or_trailing; Missing trailing pipe
(MD055, table-pipe-style)
[warning] 55-55: Table column count
Expected: 5; Actual: 1; Too few cells, row will be missing data
(MD056, table-column-count)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/home/releases/release-version.md` around lines 54 - 55, Remove the
duplicate compatibility-matrix sentence, retain a single sentence after the
table, and insert a blank line before it so Markdown parses the table correctly.
Source: Linters/SAST tools
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
Summary by CodeRabbit