fix(nxdev): typedoc devkit links (#8734)

nrwl · Jan 28, 2022 · c9c1774 · c9c1774 · vercel · Jan 28, 2022
1 parent ee71515
commit c9c1774
Show file tree

Hide file tree

Showing 13 changed files with 552 additions and 564 deletions.
diff --git a/docs/generated/api-nx-devkit/index.md b/docs/generated/api-nx-devkit/index.md
diff --git a/docs/generated/api-nx-devkit/ngcli_adapter.md b/docs/generated/api-nx-devkit/ngcli_adapter.md
@@ -4,13 +4,13 @@
 
 ### Ng CLI Adapter Classes
 
-- [NxScopedHost](../../generated/nx-devkit/ngcli_adapter#nxscopedhost)
+- [NxScopedHost](../../nx-devkit/ngcli_adapter#nxscopedhost)
 
 ### Functions
 
-- [mockSchematicsForTesting](../../generated/nx-devkit/ngcli_adapter#mockschematicsfortesting)
-- [overrideCollectionResolutionForTesting](../../generated/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
-- [wrapAngularDevkitSchematic](../../generated/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
+- [mockSchematicsForTesting](../../nx-devkit/ngcli_adapter#mockschematicsfortesting)
+- [overrideCollectionResolutionForTesting](../../nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
+- [wrapAngularDevkitSchematic](../../nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
 
 ## Ng CLI Adapter Classes
 
@@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({
 
 ### wrapAngularDevkitSchematic
 
-▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../generated/nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
+▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
 
 #### Parameters
 
@@ -108,10 +108,10 @@ overrideCollectionResolutionForTesting({
 
 ##### Parameters
 
-| Name               | Type                                           |
-| :----------------- | :--------------------------------------------- |
-| `host`             | [`Tree`](../../generated/nx-devkit/index#tree) |
-| `generatorOptions` | `Object`                                       |
+| Name               | Type                                 |
+| :----------------- | :----------------------------------- |
+| `host`             | [`Tree`](../../nx-devkit/index#tree) |
+| `generatorOptions` | `Object`                             |
 
 ##### Returns
 

diff --git a/nx-dev/nx-dev/public/documentation/generated/api-nx-devkit/index.md b/nx-dev/nx-dev/public/documentation/generated/api-nx-devkit/index.md
diff --git a/nx-dev/nx-dev/public/documentation/generated/api-nx-devkit/ngcli_adapter.md b/nx-dev/nx-dev/public/documentation/generated/api-nx-devkit/ngcli_adapter.md
@@ -4,13 +4,13 @@
 
 ### Ng CLI Adapter Classes
 
-- [NxScopedHost](../../generated/nx-devkit/ngcli_adapter#nxscopedhost)
+- [NxScopedHost](../../nx-devkit/ngcli_adapter#nxscopedhost)
 
 ### Functions
 
-- [mockSchematicsForTesting](../../generated/nx-devkit/ngcli_adapter#mockschematicsfortesting)
-- [overrideCollectionResolutionForTesting](../../generated/nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
-- [wrapAngularDevkitSchematic](../../generated/nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
+- [mockSchematicsForTesting](../../nx-devkit/ngcli_adapter#mockschematicsfortesting)
+- [overrideCollectionResolutionForTesting](../../nx-devkit/ngcli_adapter#overridecollectionresolutionfortesting)
+- [wrapAngularDevkitSchematic](../../nx-devkit/ngcli_adapter#wrapangulardevkitschematic)
 
 ## Ng CLI Adapter Classes
 
@@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({
 
 ### wrapAngularDevkitSchematic
 
-▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../generated/nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
+▸ **wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../nx-devkit/index#tree), `generatorOptions`: { [k: string]: `any`; }) => `Promise`<`any`\>
 
 #### Parameters
 
@@ -108,10 +108,10 @@ overrideCollectionResolutionForTesting({
 
 ##### Parameters
 
-| Name               | Type                                           |
-| :----------------- | :--------------------------------------------- |
-| `host`             | [`Tree`](../../generated/nx-devkit/index#tree) |
-| `generatorOptions` | `Object`                                       |
+| Name               | Type                                 |
+| :----------------- | :----------------------------------- |
+| `host`             | [`Tree`](../../nx-devkit/index#tree) |
+| `generatorOptions` | `Object`                             |
 
 ##### Returns
 

diff --git a/nx-dev/nx-dev/public/documentation/generated/cli/workspace-lint.md b/nx-dev/nx-dev/public/documentation/generated/cli/workspace-lint.md
@@ -1,11 +1,11 @@
 ---
 title: 'workspace-lint - CLI command'
-description: 'Lint nx specific workspace files (nx.json, workspace.json) and check existence of the configured packages and apps.  Note: To exclude files from this lint rule, you can add them to the `.nxignore` file'
+description: 'Lint nx specific workspace files (nx.json, workspace.json), checks if your configuration and your source code are in sync. This command identifies projects with no files in the configured project root folder, as well as files that are not part of any projects in the workspace. Note: To exclude files from this lint rule, you can add them to the `.nxignore` file.'
 ---
 
 # workspace-lint
 
-Lint nx specific workspace files (nx.json, workspace.json) and check existence of the configured packages and apps. Note: To exclude files from this lint rule, you can add them to the `.nxignore` file
+Lint nx specific workspace files (nx.json, workspace.json), checks if your configuration and your source code are in sync. This command identifies projects with no files in the configured project root folder, as well as files that are not part of any projects in the workspace. Note: To exclude files from this lint rule, you can add them to the `.nxignore` file.
 
 ## Usage
 

diff --git a/nx-dev/nx-dev/public/documentation/shared/angular-plugin.md b/nx-dev/nx-dev/public/documentation/shared/angular-plugin.md
@@ -18,10 +18,10 @@ The Nx Plugin for Angular contains executors, generators, and utilities for mana
 Adding the Angular plugin to an existing Nx workspace can be done with the following:
 
 ```bash
-#yarn
 yarn add -D @nrwl/angular
+```
 
-#npm
+```bash
 npm install -D @nrwl/angular
 ```
 

diff --git a/nx-dev/nx-dev/public/documentation/shared/cypress-plugin.md b/nx-dev/nx-dev/public/documentation/shared/cypress-plugin.md
@@ -27,19 +27,17 @@ You can create a new Cypress E2E project for an existing project.
 
 If the `@nrwl/cypress` package is not installed, install the version that matches your `@nrwl/workspace` version.
 
-```sh
-#yarn
+```bash
 yarn add --dev @nrwl/cypress
 ```
 
-```sh
-#npm
+```bash
 npm install --save-dev @nrwl/cypress
 ```
 
 Next, generate an E2E project based on an existing project.
 
-```sh
+```bash
 nx g @nrwl/cypress:cypress-project your-app-name-e2e --project=your-app-name
 ```
 

diff --git a/nx-dev/nx-dev/public/documentation/shared/express-plugin.md b/nx-dev/nx-dev/public/documentation/shared/express-plugin.md
@@ -7,12 +7,10 @@ The Express plugin contains generators to add a new Express application to an Nx
 Adding the Express plugin to a workspace can be done with the following:
 
 ```bash
-#yarn
 yarn add -D @nrwl/express
 ```
 
 ```bash
-#npm
 npm install -D @nrwl/express
 ```
 

diff --git a/nx-dev/nx-dev/public/documentation/shared/node-plugin.md b/nx-dev/nx-dev/public/documentation/shared/node-plugin.md
@@ -7,12 +7,10 @@ The Node Plugin contains generators and executors to manage Node applications wi
 Installing the Node plugin to a workspace can be done with the following:
 
 ```bash
-#yarn
 yarn add -D @nrwl/node
 ```
 
 ```bash
-#npm
 npm install -D @nrwl/node
 ```
 

diff --git a/nx-dev/nx-dev/public/documentation/shared/react-native-plugin.md b/nx-dev/nx-dev/public/documentation/shared/react-native-plugin.md
@@ -13,12 +13,10 @@ The Nx Plugin for React Native contains generators for managing React Native app
 Adding the React plugin to a workspace can be done with the following:
 
 ```bash
-#yarn
 yarn add -D @nrwl/react-native
 ```
 
 ```bash
-#npm
 npm install -D @nrwl/react-native
 ```
 

diff --git a/nx-dev/nx-dev/public/documentation/shared/react-plugin.md b/nx-dev/nx-dev/public/documentation/shared/react-plugin.md
@@ -14,12 +14,10 @@ The Nx Plugin for React contains generators for managing React applications and
 Adding the React plugin to a workspace can be done with the following:
 
 ```bash
-#yarn
 yarn add -D @nrwl/react
 ```
 
 ```bash
-#npm
 npm install -D @nrwl/react
 ```
 

diff --git a/nx-dev/nx-dev/public/documentation/shared/web-plugin.md b/nx-dev/nx-dev/public/documentation/shared/web-plugin.md
@@ -11,12 +11,10 @@ The Nx Plugin for Web Components contains generators for managing Web Component
 Adding the Web plugin to a workspace can be done with the following:
 
 ```bash
-#yarn
 yarn add -D @nrwl/web
 ```
 
 ```bash
-#npm
 npm install -D @nrwl/web
 ```
 

diff --git a/scripts/documentation/generate-devkit-documentation.ts b/scripts/documentation/generate-devkit-documentation.ts
@@ -12,7 +12,7 @@ export function generateDevkitDocumentation() {
   execSync('nx build typedoc-theme', execSyncOptions);
 
   execSync(
-    `rm -rf docs/generated/api-nx-devkit && npx typedoc packages/devkit/index.ts packages/devkit/ngcli-adapter.ts --tsconfig packages/devkit/tsconfig.lib.json --out ./docs/generated/api-nx-devkit --hideBreadcrumbs true --disableSources --publicPath ../../generated/nx-devkit/ --theme dist/typedoc-theme/src/lib --readme none`,
+    `rm -rf docs/generated/api-nx-devkit && npx typedoc packages/devkit/index.ts packages/devkit/ngcli-adapter.ts --tsconfig packages/devkit/tsconfig.lib.json --out ./docs/generated/api-nx-devkit --hideBreadcrumbs true --disableSources --publicPath ../../nx-devkit/ --theme dist/typedoc-theme/src/lib --readme none`,
     execSyncOptions
   );
   execSync(