Skip to content

doc/update: Added Compatibility matrix #240

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.

Sign up for GitHub

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
1307-Dev wants to merge 6 commits into
base: main
Choose a base branch
from
Open

doc/update: Added Compatibility matrix #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4c8ea1
Added a compatibility matrix
1307-Dev May 22, 2026
1177d59
Added changes to release version page
1307-Dev May 22, 2026
5e4a7e1
Merge branch 'main' into compatibility-matrix
1307-Dev May 22, 2026
2051ac8
Update docs/home/releases/compatibility-v5.md
1307-Dev May 22, 2026
645186e
Apply suggestion from @gemini-code-assist[bot]
1307-Dev May 22, 2026
b39bb9e
Merge branch 'main' into compatibility-matrix
1307-Dev Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/home/releases/compatibility-v5.md
View file
Open in desktop

@danielleroux danielleroux May 27, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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

@1307-Dev 1307-Dev May 27, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

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.

@1307-Dev 1307-Dev Jul 21, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

@danielleroux How do we proceed with this PR?

Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Compatibility matrix
sidebar_label: Compatibility matrix
description: 'Compatibility matrix for Siemens Industrial Experience Version 5.'
---

# Compatibility matrix

**Status:** Next · **Released:** ~ May 2026

@coderabbitai coderabbitai Bot Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 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.


## Required packages

| Package | Version |
| --- | --- |
| `@siemens/ix` | 5.x |
| `@siemens/ix-icons` | ^3.2.0 |

## Framework wrappers

| Package | Version | Framework requirement |
| --- | --- | --- |
| `@siemens/ix-react` | 5.x | React ^18 \|\| ^19 |
| `@siemens/ix-angular` | 5.x | Angular >=20 |
| `@siemens/ix-vue` | 5.x | Vue >=3.2.45 |

## Third-party integrations

| Package | Version | Library requirement |
| --- | --- | --- |
| `@siemens/ix-aggrid` | 5.x | AG Grid ^33 |
| `@siemens/ix-echarts` | 3.x | ECharts ^5.3.3 |

## Runtime

| Requirement | Version |
| --- | --- |
| Node.js | 22.x |
| TypeScript | ~5.4 – ~5.8 |

@coderabbitai coderabbitai Bot Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 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”.


## Tested in CI

We validate these library versions in the monorepo’s test applications using automated CI pipelines.

| Framework / Library | Tested version |
| --- | --- |
| React | ^19.1.0 |
| Angular | ^20.x |
| Vue | ^3.4.34 |
| Next.js | ^16.1.7 |
| Ionic (React) | ^8.7.4 |
| AG Grid | ^33.1.1 |
| ECharts | ^5.5.1 |
2 changes: 2 additions & 0 deletions docs/home/releases/release-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,5 @@ We recommend always following the active release. When a version moves from the
| V4.0.0 | Maintenance | November 2025 | May 2026 | November 2026 |
| V3.0.0 | End of life | May 2025 | November 2025 | May 2026 |
| 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).
Comment on lines +54 to +55

@coderabbitai coderabbitai Bot Jul 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 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.

Suggested change
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

1 change: 1 addition & 0 deletions sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ const sidebars: SidebarsConfig = {
items: [
'home/releases/roadmap',
'home/releases/release-version',
'home/releases/compatibility-v5',
{
type: 'link',
href: 'https://github.com/siemens/ix/releases',
Expand Down
Loading