From 16023ea67945bf7b15d76eb0e0ea2b55c60d5bb5 Mon Sep 17 00:00:00 2001
From: MaxKless <34165455+MaxKless@users.noreply.github.com>
Date: Thu, 23 Feb 2023 17:28:24 +0300
Subject: [PATCH] docs(core): add docs for new x-priority option (#15187)

---
 .../recipes/generators/generator-options.md     | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/docs/shared/recipes/generators/generator-options.md b/docs/shared/recipes/generators/generator-options.md
index 9e9abda333..e5a0942c8a 100644
--- a/docs/shared/recipes/generators/generator-options.md
+++ b/docs/shared/recipes/generators/generator-options.md
@@ -287,7 +287,8 @@ Any additional properties will be considered invalid.
     "items": [],
     "multiselect": false
   },
-  "x-deprecated": false
+  "x-deprecated": false,
+  "x-priority": "important"
 }
 ```
 
@@ -769,6 +770,20 @@ This indicates that the property `setupFile` is deprecated without a reason. The
 
 This indicates that users should use the `tsconfig` property rather than specify this property.
 
+#### `x-priority`
+
+Indicates the priority of a property. Can either be `important` or `internal`. This will be used to sort the properties on `nx.dev`, in Nx Console and when calling a generator with `--help`. `important` properties are displayed right after `required` ones while `internal` properties are shown at the end or hidden.
+
+```json
+{
+  "directory": {
+    "description": "The directory of the new application.",
+    "type": "string",
+    "x-priority": "important"
+  }
+}
+```
+
 #### `number` specific: `multipleOf`
 
 Make sure that the number can be divided by the specified number. Example: