From 26a6db208c4f807a8959c01e703c31f0ee732902 Mon Sep 17 00:00:00 2001 From: George Kalpakas Date: Fri, 25 Oct 2019 13:24:52 +0300 Subject: [PATCH] docs(docs-infra): document running docs examples in ivy mode (#33399) PR Close #33399 --- aio/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/aio/README.md b/aio/README.md index e4690504ffb6e..31b9b5619d2e1 100644 --- a/aio/README.md +++ b/aio/README.md @@ -34,17 +34,18 @@ Here are the most important tasks you might need to use: * `yarn docs-test` - run the unit tests for the doc generation code. * `yarn boilerplate:add` - generate all the boilerplate code for the examples, so that they can be run locally. - - Add the option `--local` to use your local version of Angular contained in the "dist" folder. - - Add the option `--ivy` to turn on `ivy` mode. +* `yarn boilerplate:add:ivy` - same as `boilerplate:add` but also turns on `ivy` mode. * `yarn boilerplate:remove` - remove all the boilerplate code that was added via `yarn boilerplate:add`. * `yarn generate-stackblitz` - generate the stackblitz files that are used by the `live-example` tags in the docs. * `yarn generate-zips` - generate the zip files from the examples. Zip available via the `live-example` tags in the docs. -* `yarn example-e2e` - run all e2e tests for examples - - `yarn example-e2e --setup` - force webdriver update & other setup, then run tests - - `yarn example-e2e --filter=foo` - limit e2e tests to those containing the word "foo" - - `yarn example-e2e --setup --local` - run e2e tests with the local version of Angular contained in the "dist" folder +* `yarn example-e2e` - run all e2e tests for examples. Available options: + - `--setup`: generate boilerplate, force webdriver update & other setup, then run tests. + - `--local`: run e2e tests with the local version of Angular contained in the "dist" folder. + _Requires `--setup` in order to take effect._ + - `--ivy`: run e2e tests in `ivy` mode. + - `--filter=foo`: limit e2e tests to those containing the word "foo". > **Note for Windows users** >