From c697767b0f72a9e7103c3ecd4fb182f7c343f48f Mon Sep 17 00:00:00 2001
From: Colum Ferry <cferry09@gmail.com>
Date: Mon, 10 Oct 2022 16:40:54 +0100
Subject: [PATCH] docs(angular): add downgrade module docs (#12495)

---
 docs/generated/packages/angular.json          |  1 +
 .../angular/docs/downgrade-module-examples.md | 25 +++++++++++++++++++
 .../generators/downgrade-module/schema.json   |  3 ++-
 3 files changed, 28 insertions(+), 1 deletion(-)
 create mode 100644 packages/angular/docs/downgrade-module-examples.md

diff --git a/docs/generated/packages/angular.json b/docs/generated/packages/angular.json
index 82f5d02dab..a514ce8ff4 100644
--- a/docs/generated/packages/angular.json
+++ b/docs/generated/packages/angular.json
@@ -635,6 +635,7 @@
         },
         "additionalProperties": false,
         "required": ["name", "project"],
+        "examplesFile": "## Examples\n\nBelow are some examples of how to generate configuration and setup for using `ngUpgrade`'s `DowngradeModule` for your application.\n\n{% tabs %}\n\n{% tab label=\"Basic Usage\" %}\n\n```bash\nnx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp\n```\n\n{% /tab %}\n\n{% tab label=\"Setup Router\" %}\n\nAllow a setup that configures routing for `DowngradeModule`.\n\n```bash\nnx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp --router=true\n```\n\n{% /tab %}\n\n{% /tabs %}\n",
         "presets": []
       },
       "description": "Sets up a Downgrade Module.",
diff --git a/packages/angular/docs/downgrade-module-examples.md b/packages/angular/docs/downgrade-module-examples.md
new file mode 100644
index 0000000000..9bf81e20b1
--- /dev/null
+++ b/packages/angular/docs/downgrade-module-examples.md
@@ -0,0 +1,25 @@
+## Examples
+
+Below are some examples of how to generate configuration and setup for using `ngUpgrade`'s `DowngradeModule` for your application.
+
+{% tabs %}
+
+{% tab label="Basic Usage" %}
+
+```bash
+nx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp
+```
+
+{% /tab %}
+
+{% tab label="Setup Router" %}
+
+Allow a setup that configures routing for `DowngradeModule`.
+
+```bash
+nx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp --router=true
+```
+
+{% /tab %}
+
+{% /tabs %}
diff --git a/packages/angular/src/generators/downgrade-module/schema.json b/packages/angular/src/generators/downgrade-module/schema.json
index 470c61522c..7af8195b25 100644
--- a/packages/angular/src/generators/downgrade-module/schema.json
+++ b/packages/angular/src/generators/downgrade-module/schema.json
@@ -34,5 +34,6 @@
     }
   },
   "additionalProperties": false,
-  "required": ["name", "project"]
+  "required": ["name", "project"],
+  "examplesFile": "../../../docs/downgrade-module-examples.md"
 }