Skip to content

Commit 1d67561

Browse files
committed
docs(angular): add reason for syncing
1 parent 1167c97 commit 1d67561

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/angular/testing.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Ionic Framework supports multiple versions of Angular. As a result, we need to v
44

55
## Syncing Local Changes
66

7-
The Angular test app supports syncing your locally built changes for validation.
7+
The Angular test app supports syncing your locally built changes for validation. This allows you to test local changes like `core` without having to publish a new version of the package.
88

99
1. Build the `core` directory.
1010
2. Navigate to `packages/angular` and run `npm run sync`.
@@ -16,6 +16,12 @@ The Angular test app supports syncing your locally built changes for validation.
1616

1717
From here you can either build the application or start a local dev server. When re-syncing changes, you will need to [wipe or disable the application cache](#application-cache).
1818

19+
> [!NOTE]
20+
> Syncing is required to verify that the minimal supported Angular version is still compatible with the latest Ionic Framework changes.
21+
> For example, Ionic Framework 8 supports Angular 16, but the latest version of Ionic Framework may not be compatible with Angular 16. Syncing allows you to verify that the latest changes are still compatible with the minimal supported version.
22+
>
23+
> Support for the minimal version and maximum version can be found on the [Support page](https://ionicframework.com/docs/reference/support#ionic-angular) of the Ionic Framework documentation.
24+
1925
## Application Cache
2026

2127
Angular CLI creates a cache of several files on disk by default in the `.angular` directory. This decreases the time taken to build the test application. However, the cache makes it difficult to quickly sync and check local changes of Ionic. As a result, the `.angular` cache is disabled by default in the test app projects.

0 commit comments

Comments
 (0)