Add "subspaceName" docs to rush.json init template

octogonz · octogonz · commit 6266d516d50a · 2024-05-09T19:52:55.000-07:00
diff --git a/libraries/rush-lib/assets/rush-init/rush.json b/libraries/rush-lib/assets/rush-init/rush.json
@@ -327,12 +327,19 @@
        */
       "projectFolder": "apps/my-app",
 
+      /**
+       * This field is only used if "subspacesEnabled" is true in subspaces.json.
+       * It specifies the subspace that this project belongs to.  If omitted, then the
+       * project belongs to the "default" subspace.
+       */
+      /*[LINE "HYPOTHETICAL"]*/ "subspaceName": "my-subspace",
+
       /**
        * An optional category for usage in the "browser-approved-packages.json"
        * and "nonbrowser-approved-packages.json" files.  The value must be one of the
        * strings from the "reviewCategories" defined above.
        */
-      "reviewCategory": "production",
+      /*[LINE "HYPOTHETICAL"]*/ "reviewCategory": "production",
 
       /**
        * A list of Rush project names that are to be installed from NPM
