Skip to content

Commit 63cb968

Browse files
authored
docs(angular): update README for clear directory paths (#28098)
Issue number: N/A --------- <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> - The instructions doesn't provide clear directory paths for syncing local changes. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - The instructions has clear directory paths for syncing local changes. - Switched to the `[!NOTE]` for notes. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> N/A
1 parent 7dc9d2d commit 63cb968

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

packages/angular/test/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Angular test app supports syncing your locally built changes for validation.
88

99
1. Build the `core` and `packages/angular` directories using `npm run build`.
1010
2. [Build the Angular test app](#test-app-build-structure).
11-
3. Navigate to the built test app.
11+
3. Navigate to the built test app directory (e.g. `packages/angular/test/build/ng14`).
1212
4. Install dependencies using `npm install`.
1313
5. Sync your local changes using `npm run sync`.
1414

@@ -22,22 +22,27 @@ See https://angular.io/cli/cache for more information.
2222

2323
### Disable Cache
2424

25-
```
25+
```shell
2626
ng cache disable
2727
```
2828

29-
> Note: You may need to manually remove the `.angular` directory once after running this command.
29+
> [!NOTE]
30+
> You may need to manually remove the `.angular` directory once after running this command.
3031
3132
### Enable Cache
3233

33-
```
34+
```shell
3435
ng cache enable
3536
```
3637

37-
> Note: You will need to delete the `.angular` cache and restart the dev server every time you want to sync local changes of Ionic.
38+
> [!NOTE]
39+
> You will need to delete the `.angular` cache and restart the dev server every time you want to sync local changes of Ionic.
3840
3941
## Test App Build Structure
4042

43+
> [!NOTE]
44+
> Please confirm your current directory as `packages/angular/test` before proceeding with any of the following commands.
45+
4146
Unlike other test applications, these test apps are broken up into multiple directories. These directories are then combined to create a single application. This allows us to share common application code, tests, etc so that each app is being tested the same way. Below details the different pieces that help create a single test application.
4247

4348
**apps** - This directory contains partial applications for each version of Angular we want to test. Typically these directories contain new `package.json` files, `angular.json` files, and more. If you have code that is specific to a particular version of Angular, put it in this directory.

0 commit comments

Comments
 (0)