Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .env.pullrequest
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
DOCS_BRANCH='main'
DOCS_BRANCH_TYPE='pull request'

DOCS_PR_NUMBER='2420'
Copy link
Contributor

Choose a reason for hiding this comment

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

high

Hardcoding the pull request number DOCS_PR_NUMBER makes this configuration specific to PR #2420 and not reusable for other pull requests. This could lead to issues in CI/CD pipelines for other PRs if this file is used. It's recommended to source this value from an environment variable provided by the CI system (e.g., process.env.GITHUB_PULL_REQUEST_NUMBER on GitHub Actions).

8 changes: 5 additions & 3 deletions docs/home/installation/angular.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ import TabItem from '@theme/TabItem';

### Peer dependencies

Both `@angular/core` and `@angular/forms` are peer dependencies which means they must be installed before iX.
Both `@angular/core` and `@angular/forms` are peer dependencies that you must install before iX.

For the exact version requirements, see the [peerDependencies in package.json](https://github.com/siemens/ix/blob/main/packages/angular/package.json) (search for `peerDependencies` in that file).

```json
"peerDependencies": {
"@angular/core": ">=18.2.13",
"@angular/forms": ">=18.2.13",
"@angular/core": ">=20",
"@angular/forms": ">=20",
}
```
Comment on lines 20 to 25
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This code block showing peerDependencies is redundant, as you've just added a link to the package.json file which is the source of truth. This hardcoded snippet can become outdated and mislead users. To avoid this, I suggest removing the code block.

References
  1. The style guide recommends avoiding redundancy ('less is always more'). The code block with version numbers is redundant because a link to the source of truth (package.json) is already provided on line 18. (link)


Expand Down
Loading