From 63cb96831e7a169fac5448cfa165f2308796b109 Mon Sep 17 00:00:00 2001 From: Maria Hutt Date: Thu, 31 Aug 2023 15:46:29 -0700 Subject: [PATCH] docs(angular): update README for clear directory paths (#28098) Issue number: N/A --------- ## What is the current behavior? - The instructions doesn't provide clear directory paths for syncing local changes. ## What is the new behavior? - 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 ## Other information N/A --- packages/angular/test/README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/packages/angular/test/README.md b/packages/angular/test/README.md index 44c1a5e1da..779b19ab02 100644 --- a/packages/angular/test/README.md +++ b/packages/angular/test/README.md @@ -8,7 +8,7 @@ The Angular test app supports syncing your locally built changes for validation. 1. Build the `core` and `packages/angular` directories using `npm run build`. 2. [Build the Angular test app](#test-app-build-structure). -3. Navigate to the built test app. +3. Navigate to the built test app directory (e.g. `packages/angular/test/build/ng14`). 4. Install dependencies using `npm install`. 5. Sync your local changes using `npm run sync`. @@ -22,22 +22,27 @@ See https://angular.io/cli/cache for more information. ### Disable Cache -``` +```shell ng cache disable ``` -> Note: You may need to manually remove the `.angular` directory once after running this command. +> [!NOTE] +> You may need to manually remove the `.angular` directory once after running this command. ### Enable Cache -``` +```shell ng cache enable ``` -> Note: You will need to delete the `.angular` cache and restart the dev server every time you want to sync local changes of Ionic. +> [!NOTE] +> You will need to delete the `.angular` cache and restart the dev server every time you want to sync local changes of Ionic. ## Test App Build Structure +> [!NOTE] +> Please confirm your current directory as `packages/angular/test` before proceeding with any of the following commands. + 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. **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.