Skip to content

Commit ae8e028

Browse files
bcabanesbcabanes
authored
docs(core): move package documents into its own folder (#13935)
Signed-off-by: Ben <3447705+bcabanes@users.noreply.github.com>
1 parent 7beee3c commit ae8e028

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+118
-118
lines changed

‎docs/generated/manifests/packages.json

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"isExternal": false,
2727
"path": "/packages/angular/documents/overview",
2828
"tags": [],
29-
"originalFilePath": "shared/angular-plugin"
29+
"originalFilePath": "shared/packages/angular/angular-plugin"
3030
},
3131
"/packages/angular/documents/angular-nx-version-matrix": {
3232
"id": "angular-nx-version-matrix",
@@ -37,7 +37,7 @@
3737
"isExternal": false,
3838
"path": "/packages/angular/documents/angular-nx-version-matrix",
3939
"tags": [],
40-
"originalFilePath": "shared/angular-nx-version-matrix"
40+
"originalFilePath": "shared/packages/angular/angular-nx-version-matrix"
4141
}
4242
},
4343
"root": "/packages/angular",
@@ -468,7 +468,7 @@
468468
"isExternal": false,
469469
"path": "/packages/cypress/documents/overview",
470470
"tags": [],
471-
"originalFilePath": "shared/cypress-plugin"
471+
"originalFilePath": "shared/packages/cypress/cypress-plugin"
472472
},
473473
"/packages/cypress/documents/cypress-component-testing": {
474474
"id": "cypress-component-testing",
@@ -479,7 +479,7 @@
479479
"isExternal": false,
480480
"path": "/packages/cypress/documents/cypress-component-testing",
481481
"tags": [],
482-
"originalFilePath": "shared/guides/cypress/cypress-component-testing"
482+
"originalFilePath": "shared/packages/cypress/cypress-component-testing"
483483
},
484484
"/packages/cypress/documents/v11-migration-guide": {
485485
"id": "v11-migration-guide",
@@ -490,7 +490,7 @@
490490
"isExternal": false,
491491
"path": "/packages/cypress/documents/v11-migration-guide",
492492
"tags": [],
493-
"originalFilePath": "shared/guides/cypress/cypress-v11-migration"
493+
"originalFilePath": "shared/packages/cypress/cypress-v11-migration"
494494
}
495495
},
496496
"root": "/packages/cypress",
@@ -561,7 +561,7 @@
561561
"isExternal": false,
562562
"path": "/packages/detox/documents/overview",
563563
"tags": [],
564-
"originalFilePath": "shared/detox-plugin"
564+
"originalFilePath": "shared/packages/detox/detox-plugin"
565565
}
566566
},
567567
"root": "/packages/detox",
@@ -658,7 +658,7 @@
658658
"isExternal": false,
659659
"path": "/packages/esbuild/documents/overview",
660660
"tags": [],
661-
"originalFilePath": "shared/esbuild-plugin"
661+
"originalFilePath": "shared/packages/esbuild/esbuild-plugin"
662662
}
663663
},
664664
"root": "/packages/esbuild",
@@ -711,7 +711,7 @@
711711
"isExternal": false,
712712
"path": "/packages/eslint-plugin-nx/documents/overview",
713713
"tags": [],
714-
"originalFilePath": "shared/eslint-plugin-nx"
714+
"originalFilePath": "shared/packages/linter/eslint-plugin-nx"
715715
}
716716
},
717717
"root": "/packages/eslint-plugin-nx",
@@ -947,7 +947,7 @@
947947
"isExternal": false,
948948
"path": "/packages/express/documents/overview",
949949
"tags": [],
950-
"originalFilePath": "shared/express-plugin"
950+
"originalFilePath": "shared/packages/express/express-plugin"
951951
}
952952
},
953953
"root": "/packages/express",
@@ -990,7 +990,7 @@
990990
"isExternal": false,
991991
"path": "/packages/jest/documents/overview",
992992
"tags": [],
993-
"originalFilePath": "shared/jest-plugin"
993+
"originalFilePath": "shared/packages/jest/jest-plugin"
994994
}
995995
},
996996
"root": "/packages/jest",
@@ -1043,7 +1043,7 @@
10431043
"isExternal": false,
10441044
"path": "/packages/js/documents/overview",
10451045
"tags": [],
1046-
"originalFilePath": "shared/js-plugin"
1046+
"originalFilePath": "shared/packages/js/js-plugin"
10471047
}
10481048
},
10491049
"root": "/packages/js",
@@ -1123,7 +1123,7 @@
11231123
"isExternal": false,
11241124
"path": "/packages/linter/documents/overview",
11251125
"tags": [],
1126-
"originalFilePath": "shared/linter-plugin"
1126+
"originalFilePath": "shared/packages/linter/linter-plugin"
11271127
},
11281128
"/packages/linter/documents/eslint-plugin-nx": {
11291129
"id": "eslint-plugin-nx",
@@ -1134,7 +1134,7 @@
11341134
"isExternal": false,
11351135
"path": "/packages/linter/documents/eslint-plugin-nx",
11361136
"tags": [],
1137-
"originalFilePath": "shared/eslint-plugin-nx"
1137+
"originalFilePath": "shared/packages/linter/eslint-plugin-nx"
11381138
}
11391139
},
11401140
"root": "/packages/linter",
@@ -1199,7 +1199,7 @@
11991199
"isExternal": false,
12001200
"path": "/packages/nest/documents/overview",
12011201
"tags": [],
1202-
"originalFilePath": "shared/nest-plugin"
1202+
"originalFilePath": "shared/packages/nest/nest-plugin"
12031203
}
12041204
},
12051205
"root": "/packages/nest",
@@ -1395,7 +1395,7 @@
13951395
"isExternal": false,
13961396
"path": "/packages/next/documents/overview",
13971397
"tags": [],
1398-
"originalFilePath": "shared/next-plugin"
1398+
"originalFilePath": "shared/packages/next/next-plugin"
13991399
}
14001400
},
14011401
"root": "/packages/next",
@@ -1502,7 +1502,7 @@
15021502
"isExternal": false,
15031503
"path": "/packages/node/documents/overview",
15041504
"tags": [],
1505-
"originalFilePath": "shared/node-plugin"
1505+
"originalFilePath": "shared/packages/node/node-plugin"
15061506
}
15071507
},
15081508
"root": "/packages/node",
@@ -1878,7 +1878,7 @@
18781878
"isExternal": false,
18791879
"path": "/packages/nx-plugin/documents/overview",
18801880
"tags": [],
1881-
"originalFilePath": "shared/nx-plugin"
1881+
"originalFilePath": "shared/packages/nx-plugin/nx-plugin"
18821882
}
18831883
},
18841884
"root": "/packages/nx-plugin",
@@ -1967,7 +1967,7 @@
19671967
"isExternal": false,
19681968
"path": "/packages/react/documents/overview",
19691969
"tags": [],
1970-
"originalFilePath": "shared/react-plugin"
1970+
"originalFilePath": "shared/packages/react/react-plugin"
19711971
}
19721972
},
19731973
"root": "/packages/react",
@@ -2155,7 +2155,7 @@
21552155
"isExternal": false,
21562156
"path": "/packages/react-native/documents/overview",
21572157
"tags": [],
2158-
"originalFilePath": "shared/react-native-plugin"
2158+
"originalFilePath": "shared/packages/react-native/react-native-plugin"
21592159
}
21602160
},
21612161
"root": "/packages/react-native",
@@ -2366,7 +2366,7 @@
23662366
"isExternal": false,
23672367
"path": "/packages/storybook/documents/overview",
23682368
"tags": [],
2369-
"originalFilePath": "shared/guides/storybook/plugin-overview"
2369+
"originalFilePath": "shared/packages/storybook/plugin-overview"
23702370
},
23712371
"/packages/storybook/documents/overview-react": {
23722372
"id": "overview-react",
@@ -2377,7 +2377,7 @@
23772377
"isExternal": false,
23782378
"path": "/packages/storybook/documents/overview-react",
23792379
"tags": [],
2380-
"originalFilePath": "shared/guides/storybook/plugin-react"
2380+
"originalFilePath": "shared/packages/storybook/plugin-react"
23812381
},
23822382
"/packages/storybook/documents/overview-angular": {
23832383
"id": "overview-angular",
@@ -2388,7 +2388,7 @@
23882388
"isExternal": false,
23892389
"path": "/packages/storybook/documents/overview-angular",
23902390
"tags": [],
2391-
"originalFilePath": "shared/guides/storybook/plugin-angular"
2391+
"originalFilePath": "shared/packages/storybook/plugin-angular"
23922392
},
23932393
"/packages/storybook/documents/best-practices": {
23942394
"id": "best-practices",
@@ -2399,7 +2399,7 @@
23992399
"isExternal": false,
24002400
"path": "/packages/storybook/documents/best-practices",
24012401
"tags": [],
2402-
"originalFilePath": "shared/guides/storybook/best-practices"
2402+
"originalFilePath": "shared/packages/storybook/best-practices"
24032403
},
24042404
"/packages/storybook/documents/storybook-composition-setup": {
24052405
"id": "storybook-composition-setup",
@@ -2410,7 +2410,7 @@
24102410
"isExternal": false,
24112411
"path": "/packages/storybook/documents/storybook-composition-setup",
24122412
"tags": [],
2413-
"originalFilePath": "shared/guides/storybook/storybook-composition-setup"
2413+
"originalFilePath": "shared/packages/storybook/storybook-composition-setup"
24142414
},
24152415
"/packages/storybook/documents/angular-storybook-compodoc": {
24162416
"id": "angular-storybook-compodoc",
@@ -2421,7 +2421,7 @@
24212421
"isExternal": false,
24222422
"path": "/packages/storybook/documents/angular-storybook-compodoc",
24232423
"tags": [],
2424-
"originalFilePath": "shared/guides/storybook/angular-storybook-compodoc"
2424+
"originalFilePath": "shared/packages/storybook/angular-storybook-compodoc"
24252425
},
24262426
"/packages/storybook/documents/angular-storybook-targets": {
24272427
"id": "angular-storybook-targets",
@@ -2432,7 +2432,7 @@
24322432
"isExternal": false,
24332433
"path": "/packages/storybook/documents/angular-storybook-targets",
24342434
"tags": [],
2435-
"originalFilePath": "shared/guides/storybook/angular-storybook-targets"
2435+
"originalFilePath": "shared/packages/storybook/angular-storybook-targets"
24362436
},
24372437
"/packages/storybook/documents/angular-configuring-styles": {
24382438
"id": "angular-configuring-styles",
@@ -2443,7 +2443,7 @@
24432443
"isExternal": false,
24442444
"path": "/packages/storybook/documents/angular-configuring-styles",
24452445
"tags": [],
2446-
"originalFilePath": "shared/guides/storybook/angular-configuring-styles"
2446+
"originalFilePath": "shared/packages/storybook/angular-configuring-styles"
24472447
},
24482448
"/packages/storybook/documents/angular-browser-target": {
24492449
"id": "angular-browser-target",
@@ -2454,7 +2454,7 @@
24542454
"isExternal": false,
24552455
"path": "/packages/storybook/documents/angular-browser-target",
24562456
"tags": [],
2457-
"originalFilePath": "shared/guides/storybook/angular-browser-target"
2457+
"originalFilePath": "shared/packages/storybook/angular-browser-target"
24582458
},
24592459
"/packages/storybook/documents/migrate-webpack-final-angular": {
24602460
"id": "migrate-webpack-final-angular",
@@ -2465,7 +2465,7 @@
24652465
"isExternal": false,
24662466
"path": "/packages/storybook/documents/migrate-webpack-final-angular",
24672467
"tags": [],
2468-
"originalFilePath": "shared/guides/storybook/migrate-webpack-final-angular"
2468+
"originalFilePath": "shared/packages/storybook/migrate-webpack-final-angular"
24692469
},
24702470
"/packages/storybook/documents/upgrade-storybook-v6-angular": {
24712471
"id": "upgrade-storybook-v6-angular",
@@ -2476,7 +2476,7 @@
24762476
"isExternal": false,
24772477
"path": "/packages/storybook/documents/upgrade-storybook-v6-angular",
24782478
"tags": [],
2479-
"originalFilePath": "shared/guides/storybook/storybook-v6-angular"
2479+
"originalFilePath": "shared/packages/storybook/storybook-v6-angular"
24802480
},
24812481
"/packages/storybook/documents/migrate-webpack-final-react": {
24822482
"id": "migrate-webpack-final-react",
@@ -2487,7 +2487,7 @@
24872487
"isExternal": false,
24882488
"path": "/packages/storybook/documents/migrate-webpack-final-react",
24892489
"tags": [],
2490-
"originalFilePath": "shared/guides/storybook/migrate-webpack-final-react"
2490+
"originalFilePath": "shared/packages/storybook/migrate-webpack-final-react"
24912491
},
24922492
"/packages/storybook/documents/upgrade-storybook-v6-react": {
24932493
"id": "upgrade-storybook-v6-react",
@@ -2498,7 +2498,7 @@
24982498
"isExternal": false,
24992499
"path": "/packages/storybook/documents/upgrade-storybook-v6-react",
25002500
"tags": [],
2501-
"originalFilePath": "shared/guides/storybook/storybook-v6-react"
2501+
"originalFilePath": "shared/packages/storybook/storybook-v6-react"
25022502
}
25032503
},
25042504
"root": "/packages/storybook",
@@ -2590,7 +2590,7 @@
25902590
"isExternal": false,
25912591
"path": "/packages/vite/documents/overview",
25922592
"tags": [],
2593-
"originalFilePath": "shared/vite-plugin"
2593+
"originalFilePath": "shared/packages/vite/vite-plugin"
25942594
}
25952595
},
25962596
"root": "/packages/vite",
@@ -2670,7 +2670,7 @@
26702670
"isExternal": false,
26712671
"path": "/packages/web/documents/overview",
26722672
"tags": [],
2673-
"originalFilePath": "shared/web-plugin"
2673+
"originalFilePath": "shared/packages/web/web-plugin"
26742674
}
26752675
},
26762676
"root": "/packages/web",
@@ -2809,7 +2809,7 @@
28092809
"isExternal": false,
28102810
"path": "/packages/workspace/documents/overview",
28112811
"tags": [],
2812-
"originalFilePath": "shared/workspace-plugin"
2812+
"originalFilePath": "shared/packages/workspace/workspace-plugin"
28132813
},
28142814
"/packages/workspace/documents/nx-nodejs-typescript-version-matrix": {
28152815
"id": "nx-nodejs-typescript-version-matrix",
@@ -2820,7 +2820,7 @@
28202820
"isExternal": false,
28212821
"path": "/packages/workspace/documents/nx-nodejs-typescript-version-matrix",
28222822
"tags": [],
2823-
"originalFilePath": "shared/nx-compatibility-matrix"
2823+
"originalFilePath": "shared/packages/workspace/nx-compatibility-matrix"
28242824
}
28252825
},
28262826
"root": "/packages/workspace",

‎docs/generated/packages/vite/documents/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ If you are using React, you need to use the [`@vitejs/plugin-react` plugin](http
168168
Add a `vite.config.ts` file to the root of your app. If you are not using React, you can skip adding the `react` plugin, of course.
169169

170170
```ts
171-
// eg. apps/my-app/vite.config.ts
171+
// e.g. apps/my-app/vite.config.ts
172172
import { defineConfig } from 'vite';
173173
import react from '@vitejs/plugin-react';
174174
import ViteTsConfigPathsPlugin from 'vite-tsconfig-paths';
@@ -193,7 +193,7 @@ In that config file, you can configure Vite.js as you would normally do. For mor
193193

194194
You can create a `vite.config.ts` file to the root of your workspace, as well as at the root of each of your applications. This file is used to configure Vite. You can read more about the configuration options in the [Vite documentation](https://vitejs.dev/config/).
195195

196-
The root `vite.config.ts` file can be used for all applications, and you can place in there general configurations that would apply for all your apps using Vite in your workspace. The application-specific `vite.config.ts` files can be used to override the root configuration, or, for example, import framework-specific plugins (eg. the `'@vitejs/plugin-react'` for React apps). The application-specific configuration files extend (using [`mergeConfig`](https://vitejs.dev/guide/api-javascript.html#mergeconfig)) the root configuration file. You can adjust this behavior to your needs.
196+
The root `vite.config.ts` file can be used for all applications, and you can place in here general configurations that would apply for all your apps using Vite in your workspace. The application-specific `vite.config.ts` files can be used to override the root configuration, or, for example, import framework-specific plugins (e.g. the `'@vitejs/plugin-react'` for React apps). The application-specific configuration files extend (using [`mergeConfig`](https://vitejs.dev/guide/api-javascript.html#mergeconfig)) the root configuration file. You can adjust this behavior to your needs.
197197

198198
So, if you are using a root `vite.config.ts` file, you should adjust your code as follows:
199199

@@ -209,7 +209,7 @@ export default defineConfig({
209209
and then in your app's `vite.config.ts` file:
210210

211211
```ts
212-
// eg. apps/my-app/vite.config.ts
212+
// e.g. apps/my-app/vite.config.ts
213213
import { mergeConfig } from 'vite';
214214
import baseConfig from '../../vite.config';
215215
import react from '@vitejs/plugin-react';
@@ -227,7 +227,7 @@ export default mergeConfig(baseConfig, {
227227

228228
### 3. Move `index.html` and point it to your app's entrypoint
229229

230-
First of all, move your `index.html` file to the root of your app (eg. from `apps/my-app/src/index.html` to `apps/my-app/index.html`).
230+
First of all, move your `index.html` file to the root of your app (e.g. from `apps/my-app/src/index.html` to `apps/my-app/index.html`).
231231

232232
Then, add a module `script` tag pointing to the `main.tsx` (or `main.ts`) file of your app:
233233

@@ -268,7 +268,7 @@ You can use the `public` folder to store static **assets**, such as images, font
268268

269269
### 5. Adjust your app's tsconfig.json
270270

271-
Change your app's `tsconfig.json` (eg. `apps/my-app/tsconfig.json`) `compilerOptions` to the following:
271+
Change your app's `tsconfig.json` (e.g. `apps/my-app/tsconfig.json`) `compilerOptions` to the following:
272272

273273
#### For React apps
274274

0 commit comments

Comments
 (0)