docs(core): add description to nextjs package (#9534)

nrwl · Mar 25, 2022 · f612666 · f612666 · vercel · Mar 25, 2022
1 parent a4da5a1
commit f612666
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 25 deletions.
diff --git a/docs/generated/packages/next.json b/docs/generated/packages/next.json
@@ -1,7 +1,7 @@
 {
   "githubRoot": "https://github.com/nrwl/nx/blob/master",
   "name": "next",
-  "description": "Next.js Plugin for Nx",
+  "description": "When using Next.js in Nx, you get the out-of-the-box support for TypeScript, Cypress, and Jest. No need to configure anything: watch mode, source maps, and typings just work.\n\nThe Next.js plugin contains executors and generators for managing Next.js applications and libraries within an Nx workspace. It provides:\n\n\n- Scaffolding for creating, building, serving, linting, and testing Next.js applications.\n\n- Integration with building, serving, and exporting a Next.js application.\n\n- Integration with React libraries within the workspace.",
   "root": "/packages/next",
   "source": "/packages/next/src",
   "generators": [
@@ -37,7 +37,7 @@
         "required": [],
         "presets": []
       },
-      "description": "Initialize the @nrwl/next plugin",
+      "description": "Initialize the `@nrwl/next` plugin.",
       "hidden": true,
       "implementation": "/packages/next/src/generators/init/init#nextInitGenerator.ts",
       "aliases": [],
@@ -170,7 +170,7 @@
       },
       "aliases": ["app"],
       "x-type": "application",
-      "description": "Create an application",
+      "description": "Create an application.",
       "implementation": "/packages/next/src/generators/application/application#applicationGenerator.ts",
       "hidden": false,
       "path": "/packages/next/src/generators/application/schema.json"
@@ -273,7 +273,7 @@
         "required": ["name", "project"],
         "presets": []
       },
-      "description": "Create a page",
+      "description": "Create a page.",
       "implementation": "/packages/next/src/generators/page/page#pageGenerator.ts",
       "aliases": [],
       "hidden": false,
@@ -379,7 +379,7 @@
         "required": ["name", "project"],
         "presets": []
       },
-      "description": "Create a component",
+      "description": "Create a component.",
       "implementation": "/packages/next/src/generators/component/component#componentGenerator.ts",
       "aliases": [],
       "hidden": false,
@@ -546,7 +546,7 @@
       },
       "aliases": ["lib"],
       "x-type": "library",
-      "description": "Create a library",
+      "description": "Create a library.",
       "implementation": "/packages/next/src/generators/library/library#libraryGenerator.ts",
       "hidden": false,
       "path": "/packages/next/src/generators/library/schema.json"
@@ -601,7 +601,7 @@
         "required": ["root", "outputPath"],
         "presets": []
       },
-      "description": "Build a Next.js app",
+      "description": "Build a Next.js application.",
       "aliases": [],
       "hidden": false,
       "path": "/packages/next/src/executors/build/schema.json"
@@ -660,7 +660,7 @@
         "required": ["buildTarget"],
         "presets": []
       },
-      "description": "Serve a Next.js app",
+      "description": "Serve a Next.js application.",
       "aliases": [],
       "hidden": false,
       "path": "/packages/next/src/executors/server/schema.json"
@@ -696,7 +696,7 @@
         "required": [],
         "presets": []
       },
-      "description": "Export a Next.js app. The exported application is located at dist/$outputPath/exported.",
+      "description": "Export a Next.js application. The exported application is located at `dist/$outputPath/exported`.",
       "aliases": [],
       "hidden": false,
       "path": "/packages/next/src/executors/export/schema.json"

diff --git a/packages/next/executors.json b/packages/next/executors.json
@@ -3,34 +3,34 @@
     "build": {
       "implementation": "./src/executors/build/build.impl",
       "schema": "./src/executors/build/schema.json",
-      "description": "Build a Next.js app"
+      "description": "Build a Next.js application."
     },
     "server": {
       "implementation": "./src/executors/server/server.impl",
       "schema": "./src/executors/server/schema.json",
-      "description": "Serve a Next.js app"
+      "description": "Serve a Next.js application."
     },
     "export": {
       "implementation": "./src/executors/export/export.impl",
       "schema": "./src/executors/export/schema.json",
-      "description": "Export a Next.js app. The exported application is located at dist/$outputPath/exported."
+      "description": "Export a Next.js application. The exported application is located at `dist/$outputPath/exported`."
     }
   },
   "builders": {
     "build": {
       "implementation": "./src/executors/build/compat",
       "schema": "./src/executors/build/schema.json",
-      "description": "Build a Next.js app"
+      "description": "Build a Next.js application."
     },
     "server": {
       "implementation": "./src/executors/server/compat",
       "schema": "./src/executors/server/schema.json",
-      "description": "Serve a Next.js app"
+      "description": "Serve a Next.js application."
     },
     "export": {
       "implementation": "./src/executors/export/compat",
       "schema": "./src/executors/export/schema.json",
-      "description": "Export a Next.js app. The exported application is located at dist/$outputPath/exported."
+      "description": "Export a Next.js application. The exported application is located at `dist/$outputPath/exported`."
     }
   }
 }
diff --git a/packages/next/generators.json b/packages/next/generators.json
@@ -6,57 +6,57 @@
     "init": {
       "factory": "./src/generators/init/init#nextInitSchematic",
       "schema": "./src/generators/init/schema.json",
-      "description": "Initialize the @nrwl/next plugin",
+      "description": "Initialize the `@nrwl/next` plugin.",
       "hidden": true
     },
     "application": {
       "factory": "./src/generators/application/application#applicationSchematic",
       "schema": "./src/generators/application/schema.json",
       "aliases": ["app"],
       "x-type": "application",
-      "description": "Create a Next.js application"
+      "description": "Create a Next.js application."
     },
     "page": {
       "factory": "./src/generators/page/page#pageSchematic",
       "schema": "./src/generators/page/schema.json",
-      "description": "Create a Next.js page component"
+      "description": "Create a Next.js page component."
     },
     "component": {
       "factory": "./src/generators/component/component#componentSchematic",
       "schema": "./src/generators/component/schema.json",
-      "description": "Create a React component"
+      "description": "Create a React component."
     }
   },
   "generators": {
     "init": {
       "factory": "./src/generators/init/init#nextInitGenerator",
       "schema": "./src/generators/init/schema.json",
-      "description": "Initialize the @nrwl/next plugin",
+      "description": "Initialize the `@nrwl/next` plugin.",
       "hidden": true
     },
     "application": {
       "factory": "./src/generators/application/application#applicationGenerator",
       "schema": "./src/generators/application/schema.json",
       "aliases": ["app"],
       "x-type": "application",
-      "description": "Create an application"
+      "description": "Create an application."
     },
     "page": {
       "factory": "./src/generators/page/page#pageGenerator",
       "schema": "./src/generators/page/schema.json",
-      "description": "Create a page"
+      "description": "Create a page."
     },
     "component": {
       "factory": "./src/generators/component/component#componentGenerator",
       "schema": "./src/generators/component/schema.json",
-      "description": "Create a component"
+      "description": "Create a component."
     },
     "library": {
       "factory": "./src/generators/library/library#libraryGenerator",
       "schema": "./src/generators/library/schema.json",
       "aliases": ["lib"],
       "x-type": "library",
-      "description": "Create a library"
+      "description": "Create a library."
     }
   }
 }
diff --git a/packages/next/package.json b/packages/next/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@nrwl/next",
   "version": "0.0.1",
-  "description": "Next.js Plugin for Nx",
+  "description": "When using Next.js in Nx, you get the out-of-the-box support for TypeScript, Cypress, and Jest. No need to configure anything: watch mode, source maps, and typings just work.\n\nThe Next.js plugin contains executors and generators for managing Next.js applications and libraries within an Nx workspace. It provides:\n\n\n- Scaffolding for creating, building, serving, linting, and testing Next.js applications.\n\n- Integration with building, serving, and exporting a Next.js application.\n\n- Integration with React libraries within the workspace.",
   "repository": {
     "type": "git",
     "url": "https://github.com/nrwl/nx.git",