feat(docs): Group core plugin docs

docs/assets/styles/_markdown.scss

@@ -22,8 +22,8 @@ $block-border-radius: 4px;
     }
 
     h1 {
-       font-size: 1.875rem;
-       line-height: 2.25rem;
+        font-size: 1.875rem;
+        line-height: 2.25rem;
     }
 
     h1:first-of-type {
@@ -32,11 +32,25 @@ $block-border-radius: 4px;
         margin-bottom: 0;
         font-size: 2.8em;
 
-        @media all and (max-width: $sm-breakpoint){
+        @media all and (max-width: $sm-breakpoint) {
             font-size: 2em;
         }
     }
 
+    .symbol {
+        border: 1px solid #ddd;
+        border-radius: 4px;
+        padding: 24px;
+        margin: 24px 0 48px 0;
+        background-color: #fafafa;
+
+        > h1:first-of-type {
+            text-transform: none;
+            font-size: 1.875rem;
+            line-height: 2.25rem;
+        }
+    }
+
     h1:not(:first-of-type) {
         margin-top: 48px;
         padding: 3px 12px;
@@ -66,7 +80,11 @@ $block-border-radius: 4px;
         margin-top: 32px;
     }
 
-    h1, h2, h3, h4, h5 {
+    h1,
+    h2,
+    h3,
+    h4,
+    h5 {
         font-family: $brand-font-face;
         letter-spacing: -0.025em;
         line-height: 1.25;
@@ -81,7 +99,9 @@ $block-border-radius: 4px;
         margin: 16px 0;
     }
 
-    b, optgroup, strong {
+    b,
+    optgroup,
+    strong {
         font-weight: 700;
     }
 
@@ -89,7 +109,8 @@ $block-border-radius: 4px;
         text-decoration: none;
         color: $color-link;
 
-        &:hover, &:visited:hover {
+        &:hover,
+        &:visited:hover {
             color: lighten($color-link, 10%);
         }
 
@@ -98,7 +119,8 @@ $block-border-radius: 4px;
         }
     }
 
-    ul, ol:not(.breadcrumbs) {
+    ul,
+    ol:not(.breadcrumbs) {
         list-style-type: initial;
         padding-left: 40px;
     }
@@ -151,8 +173,12 @@ $block-border-radius: 4px;
         color: $gray-700;
         border-left: 2px solid $gray-300;
 
-        :first-child { margin-top: 0; }
-        :last-child { margin-bottom: 0; }
+        :first-child {
+            margin-top: 0;
+        }
+        :last-child {
+            margin-bottom: 0;
+        }
 
         &::before {
             content: '“';
@@ -170,7 +196,8 @@ $block-border-radius: 4px;
         th {
             text-align: left;
         }
-        td, th {
+        td,
+        th {
             padding: $padding-4;
         }
         tr:nth-child(odd) td {
@@ -193,7 +220,8 @@ $block-border-radius: 4px;
                 box-shadow: none;
             }
         }
-        figcaption p, figcaption h4 {
+        figcaption p,
+        figcaption h4 {
             text-align: center;
             font-size: $font-size-base;
             margin-top: $padding-4;

docs/assets/styles/_menu.scss

@@ -27,7 +27,7 @@ nav.book-menu {
     }
 
     ul:not(.expanded) > .section {
-        &:nth-of-type(7) {
+        &:nth-of-type(6) {
             &::before {
                 position: absolute;
                 top: 0;
@@ -40,7 +40,7 @@ nav.book-menu {
             padding-top: 1em;
         }
 
-        &:nth-of-type(n + 7) {
+        &:nth-of-type(n + 6) {
             color: $gray-700;
         }
     }

docs/assets/styles/_search-widget.scss

@@ -66,7 +66,7 @@
         }
         .title {
             color: $gray-800;
-            width: 200px;
+            width: 300px;
             font-size: 12px;
             margin-right: 6px;
         }

docs/content/deployment/production-configuration/index.md

@@ -45,7 +45,7 @@ export const config: VendureConfig = {
 
 ## API hardening
 
-It is recommended that you install and configure the [HardenPlugin]({{< relref "harden-plugin" >}}) for all production deployments. This plugin locks down your schema (disabling introspection and field suggestions) and protects your Shop API against malicious queries that could otherwise overwhelm your server.
+It is recommended that you install and configure the [HardenPlugin]({{< relref "typescript-api/core-plugins/harden-plugin" >}}) for all production deployments. This plugin locks down your schema (disabling introspection and field suggestions) and protects your Shop API against malicious queries that could otherwise overwhelm your server.
 
 Install the plugin: 
 
@@ -78,7 +78,7 @@ export const config: VendureConfig = {
 ```
 
 {{< alert primary >}}
-For a detailed explanation of how to best configure this plugin, see the [HardenPlugin docs]({{< relref "harden-plugin" >}}).
+For a detailed explanation of how to best configure this plugin, see the [HardenPlugin docs]({{< relref "typescript-api/core-plugins/harden-plugin" >}}).
 {{< /alert >}}
 
 ## ID Strategy

docs/content/developer-guide/customizing-models.md

@@ -29,7 +29,7 @@ With the example config above, the following will occur:
 
 1. The database schema will be altered, and a column will be added for each custom field. **Note: changes to custom fields require a database migration**. See the [Migrations guide]({{< relref "migrations" >}}).
 2. The GraphQL APIs will be modified to add the custom fields to the `Product` and `User` types respectively.
-3. If you are using the [admin-ui-plugin]({{< relref "/typescript-api/admin-ui-plugin" >}}), the Admin UI detail pages will now contain form inputs to allow the custom field data to be added or edited.
+3. If you are using the [admin-ui-plugin]({{< relref "/typescript-api/core-plugins/admin-ui-plugin" >}}), the Admin UI detail pages will now contain form inputs to allow the custom field data to be added or edited.
 
 The values of the custom fields can then be set and queried via the GraphQL APIs:
 

docs/content/developer-guide/customizing-the-order-process/index.md

@@ -5,13 +5,13 @@ showtoc: true
 
 # Customizing the Order Process
 
-Vendure defines an order process which is based on a [finite state machine]({{< relref "fsm" >}}). This means that the [`Order.state` property]({{< relref "order" >}}#state) will be one of a set of [pre-defined states]({{< relref "order-state" >}}). From the current state, the Order can then transition (change) to another state, and the available next states depend on what the current state is.
+Vendure defines an order process which is based on a [finite state machine]({{< relref "fsm" >}}). This means that the [`Order.state` property]({{< relref "order" >}}#state) will be one of a set of [pre-defined states]({{< relref "order-process" >}}#orderstate). From the current state, the Order can then transition (change) to another state, and the available next states depend on what the current state is.
 
 So, as an example, all orders begin in the `AddingItems` state. This means that the Customer is adding items to his or her shopping cart. From there, the Order can transition to the `ArrangingPayment` state. A diagram of the default states and transitions can be found in the [Order Workflow guide]({{< relref "order-workflow" >}}).
 
 ## Defining custom states and transitions
 
-Sometimes you might need to modify the default Order process to better match your business needs. This is done by defining one or more [`CustomOrderProcess`]({{< relref "custom-order-process" >}}) objects and passing them to the [`OrderOptions.process`]({{< relref "order-options" >}}#process) config property.
+Sometimes you might need to modify the default Order process to better match your business needs. This is done by defining one or more [`OrderProcess`]({{< relref "order-process" >}}) objects and passing them to the [`OrderOptions.process`]({{< relref "order-options" >}}#process) config property.
 
 ### Example: Adding a new state
 
@@ -35,9 +35,9 @@ Here's how we would define the new state:
 
 ```TypeScript
 // customer-validation-process.ts
-import { CustomOrderProcess } from '@vendure/core';
+import { OrderProcess } from '@vendure/core';
 
-export const customerValidationProcess: CustomOrderProcess<'ValidatingCustomer'> = {
+export const customerValidationProcess: OrderProcess<'ValidatingCustomer'> = {
   transitions: {
     AddingItems: {
       to: ['ValidatingCustomer'],
@@ -72,9 +72,9 @@ export const config: VendureConfig = {
 
  To add multiple new States you need to extend the generic type like this:
  ```TypeScript
-import { CustomOrderProcess } from '@vendure/core';
+import { OrderProcess } from '@vendure/core';
 
-export const customerValidationProcess: CustomOrderProcess<'ValidatingCustomer'|'AnotherState'> = {...}
+export const customerValidationProcess: OrderProcess<'ValidatingCustomer'|'AnotherState'> = {...}
  ```
 This way multiple custom states gets defined.
 
@@ -91,7 +91,7 @@ This allows us to perform our custom logic and potentially prevent the transitio
 // in our onTransitionStart function.
 let taxIdService: TaxIdService;
 
-const customerValidationProcess: CustomOrderProcess<'ValidatingCustomer'> = {
+const customerValidationProcess: OrderProcess<'ValidatingCustomer'> = {
   transitions: {
     AddingItems: {
       to: ['ValidatingCustomer'],

docs/content/developer-guide/payment-integrations/index.md

@@ -146,9 +146,9 @@ If the `createPayment()` function returns a result with the state set to `'Autho
 
 ## Custom Payment Flows
 
-If you need to support an entirely different payment flow than the above, it is also possible to do so by configuring a [CustomPaymentProcess]({{< relref "custom-payment-process" >}}). This allows new Payment states and transitions to be defined, as well as allowing custom logic to run on Payment state transitions.
+If you need to support an entirely different payment flow than the above, it is also possible to do so by configuring a [PaymentProcess]({{< relref "payment-process" >}}). This allows new Payment states and transitions to be defined, as well as allowing custom logic to run on Payment state transitions.
 
-Here's an example which adds a new "Validating" state to the Payment state machine, and combines it with a [CustomOrderProcess]({{< relref "custom-order-process" >}}), [PaymentMethodHandler]({{< relref "payment-method-handler" >}}) and [OrderPlacedStrategy]({{< relref "order-placed-strategy" >}}).
+Here's an example which adds a new "Validating" state to the Payment state machine, and combines it with a [OrderProcess]({{< relref "order-process" >}}), [PaymentMethodHandler]({{< relref "payment-method-handler" >}}) and [OrderPlacedStrategy]({{< relref "order-placed-strategy" >}}).
 
 ```TypeScript
 // types.ts
@@ -158,7 +158,7 @@ import { CustomOrderStates } from '@vendure/core';
  * Declare your custom state in special interface to make it type-safe
  */
 declare module '@vendure/core' {
-  interface CustomPaymentStates {
+  interface PaymentStates {
     Validating: never;
   }
 }
@@ -167,7 +167,7 @@ declare module '@vendure/core' {
  * Define a new "Validating" Payment state, and set up the
  * permitted transitions to/from it.
  */
-const customPaymentProcess: CustomPaymentProcess<'Validating'> = {
+const customPaymentProcess: PaymentProcess<'Validating'> = {
   transitions: {
     Created: {
       to: ['Validating'],
@@ -183,7 +183,7 @@ const customPaymentProcess: CustomPaymentProcess<'Validating'> = {
  * Define a new "ValidatingPayment" Order state, and set up the
  * permitted transitions to/from it.
  */
-const customOrderProcess: CustomOrderProcess<'ValidatingPayment'> = {
+const customOrderProcess: OrderProcess<'ValidatingPayment'> = {
   transitions: {
     ArrangingPayment: {
       to: ['ValidatingPayment'],
@@ -236,7 +236,7 @@ export const config: VendureConfig = {
     orderPlacedStrategy: new MyOrderPlacedStrategy(),
   },
   paymentOptions: {
-    customPaymentProcess: [customPaymentProcess],
+    process: [customPaymentProcess],
     paymentMethodHandlers: [myPaymentHandler],
   },
 };

docs/content/developer-guide/shipping.md

@@ -151,7 +151,7 @@ Like Orders, Fulfillments are governed by a [finite state machine]({{< relref "f
 * `Delivered` The Fulfillment has arrived with the customer
 * `Cancelled` The Fulfillment has been cancelled 
 
-These states cover the typical workflow for fulfilling orders. However, it is possible to customize the fulfillment workflow by defining a [CustomFulfillmentProcess]({{< relref "custom-fulfillment-process" >}}) and passing it to your VendureConfig:
+These states cover the typical workflow for fulfilling orders. However, it is possible to customize the fulfillment workflow by defining a [FulfillmentProcess]({{< relref "fulfillment-process" >}}) and passing it to your VendureConfig:
 
 ```TypeScript
 export const config: VendureConfig = {

docs/content/plugins/_index.md

@@ -19,3 +19,8 @@ Plugins are the method by which the built-in functionality of Vendure can be ext
 These abilities make plugins a very versatile and powerful means of implementing custom business requirements.
 
 This section details the official Vendure plugins included in the main Vendure repo, as well as a guide on writing your own plugins for Vendure.
+
+{{< alert "primary" >}}
+  Vendure provides a set of **core plugins** covering common functionality such as assets handling, email sending, and search. For 
+documentation on these, see the [Core Plugins section]({{< relref "core-plugins" >}}).
+{{< /alert >}}

docs/content/storefront/order-workflow/_index.md

@@ -9,7 +9,7 @@ An Order is a collection of one or more ProductVariants which can be purchased b
 
 ## Order State
 
-Every Order has a `state` property of type [`OrderState`]({{< relref "order-state" >}}). The following diagram shows the default states and how an Order transitions from one to the next.
+Every Order has a `state` property of type [`OrderState`]({{< relref "order-process" >}}#orderstate). The following diagram shows the default states and how an Order transitions from one to the next.
 
 {{% alert %}}
 Note that this default workflow can be modified to better fit your business processes. See the [Customizing the Order Process guide]({{< relref "customizing-the-order-process" >}}).
@@ -19,14 +19,12 @@ Note that this default workflow can be modified to better fit your business proc
 
 ## Structure of an Order
 
-In Vendure an [Order]({{< relref "order" >}}) consists of one or more [OrderLines]({{< relref "order-line" >}}) (representing a given quantity of a particular SKU), which in turn contain one or more [OrderItems]({{< relref "order-item" >}}) (which represent the individual physical units). 
+In Vendure an [Order]({{< relref "order" >}}) consists of one or more [OrderLines]({{< relref "order-line" >}}) (representing a given quantity of a particular SKU).
 
 Here is a simplified diagram illustrating this relationship:
 
 {{< figure src="./order_class_diagram.png" >}}
 
-So if the customer adds 2 *Widgets* to the Order, there will be **one OrderLine** containing **two OrderItems**, one for each of the added *Widgets*.
-
 ## Shop client order workflow
 
 The [GraphQL Shop API Guide]({{< relref "/storefront/shop-api-guide" >}}#order-flow) lists the GraphQL operations you will need to implement this workflow in your storefront client application.

docs/data/build.json

@@ -1,4 +1,4 @@
 {
-  "version": "1.5.2",
-  "commit": "c4811d42e"
-}
+  "version": "2.0.0-beta.3",
+  "commit": "90a914bf5"
+}

docs/diagrams/order-class-diagram.puml

@@ -26,13 +26,7 @@ class OrderLine {
     items: OrderItem[]
 }
 
-class OrderItem {
-    unitPrice: number
-    taxRate: number
-}
-
 Order -- OrderState
 Order *-- "0..*" OrderLine
-OrderLine *-- "0..*" OrderItem
 
 @enduml

docs/layouts/_default/baseof.html

@@ -87,7 +87,7 @@
                  x-transition:leave-end="opacity-0"
             ></div>
 
-            <div class="inline-block align-bottom bg-white rounded-lg px-4 pt-5 pb-4 text-left overflow-hidden shadow-xl transform transition-all sm:my-8 sm:align-middle sm:max-w-3xl w-full sm:p-6"
+            <div class="inline-block align-bottom bg-white rounded-lg px-4 pt-5 pb-4 text-left overflow-hidden shadow-xl transform transition-all sm:my-8 sm:align-middle sm:max-w-4xl w-full sm:p-6"
                  x-show="open"
                  x-transition:enter="ease-out duration-300"
                  x-transition:enter-start="opacity-0 translate-y-4 sm:translate-y-0 sm:scale-95"

docs/layouts/partials/menu-filetree.html

@@ -1,4 +1,9 @@
 <ul>
+    <li>
+    <ul><li><a href="/getting-started" {{- if eq .Page.Title "Getting Started" }} class="text-blue-700 active"{{ end }}>
+      Getting Started
+    </a></li></ul>
+    </li>
     <li>{{ template "book-section" (dict "Section" .Site.Sections "CurrentPage" $.Permalink) }}</li>
 </ul>
 

docs/layouts/shortcodes/shop-api-operation.html

@@ -1,4 +1,4 @@
 {{- $operationName := .Get "operation" -}}
 {{- $operationSegment := cond (eq (.Get "type") "query") "queries" "mutations" -}}
-{{- $link := (print "/docs/graphql-api/shop/" $operationSegment  "#" (lower $operationName) ) -}}
+{{- $link := (print "/graphql-api/shop/" $operationSegment  "#" (lower $operationName) ) -}}
 <em>{{ .Get "type" }}</em> <a href="{{ $link }}"><code>{{ $operationName }}</code></a>

packages/admin-ui-plugin/src/plugin.ts

@@ -34,7 +34,7 @@ import { MetricsService } from './service/metrics.service';
  * @description
  * Configuration options for the {@link AdminUiPlugin}.
  *
- * @docsCategory AdminUiPlugin
+ * @docsCategory core plugins/AdminUiPlugin
  */
 export interface AdminUiPluginOptions {
     /**
@@ -101,7 +101,7 @@ export interface AdminUiPluginOptions {
  * };
  * ```
  *
- * @docsCategory AdminUiPlugin
+ * @docsCategory core plugins/AdminUiPlugin
  */
 @VendurePlugin({
     imports: [PluginCommonModule],

packages/asset-server-plugin/src/hashed-asset-naming-strategy.ts

@@ -15,7 +15,7 @@ import path from 'path';
  * With this strategy, even with 200,000 total assets stored, each directory would
  * only contain less than 800 files.
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  */
 export class HashedAssetNamingStrategy extends DefaultAssetNamingStrategy {
     generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string): string {

packages/asset-server-plugin/src/local-asset-storage-strategy.ts

@@ -10,7 +10,7 @@ import { Stream } from 'stream';
  * @description
  * A persistence strategy which saves files to the local file system.
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  */
 export class LocalAssetStorageStrategy implements AssetStorageStrategy {
     toAbsoluteUrl: ((reqest: Request, identifier: string) => string) | undefined;

packages/asset-server-plugin/src/plugin.ts

@@ -134,7 +134,7 @@ import { AssetServerOptions, ImageTransformPreset } from './types';
  * By default, the AssetServerPlugin will cache every transformed image, so that the transformation only needs to be performed a single time for
  * a given configuration. Caching can be disabled per-request by setting the `?cache=false` query parameter.
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  */
 @VendurePlugin({
     imports: [PluginCommonModule],

packages/asset-server-plugin/src/s3-asset-storage-strategy.ts

@@ -13,7 +13,7 @@ import { AssetServerOptions } from './types';
  * @description
  * Configuration for connecting to AWS S3.
  *
- * @docsCategory asset-server-plugin
+ * @docsCategory core plugins/AssetServerPlugin
  * @docsPage S3AssetStorageStrategy
  */
 export interface S3Config {
@@ -107,7 +107,7 @@ export interface S3Config {
  *     }),
  * }),
  * ```
- * @docsCategory asset-server-plugin
+ * @docsCategory core plugins/AssetServerPlugin
  * @docsPage S3AssetStorageStrategy
  */
 export function configureS3AssetStorage(s3Config: S3Config) {
@@ -151,25 +151,36 @@ export class S3AssetStorageStrategy implements AssetStorageStrategy {
     private libStorage: typeof import('@aws-sdk/lib-storage');
     private s3Client: import('@aws-sdk/client-s3').S3Client;
 
-    constructor(private s3Config: S3Config, public readonly toAbsoluteUrl: (request: Request, identifier: string) => string) {}
+    constructor(
+        private s3Config: S3Config,
+        public readonly toAbsoluteUrl: (request: Request, identifier: string) => string,
+    ) {}
 
     async init() {
         try {
             this.AWS = await import('@aws-sdk/client-s3');
         } catch (err: any) {
-            Logger.error('Could not find the "@aws-sdk/client-s3" package. Make sure it is installed', loggerCtx, err.stack);
+            Logger.error(
+                'Could not find the "@aws-sdk/client-s3" package. Make sure it is installed',
+                loggerCtx,
+                err.stack,
+            );
         }
 
         try {
             this.libStorage = await import('@aws-sdk/lib-storage');
         } catch (err: any) {
-            Logger.error('Could not find the "@aws-sdk/lib-storage" package. Make sure it is installed', loggerCtx, err.stack);
+            Logger.error(
+                'Could not find the "@aws-sdk/lib-storage" package. Make sure it is installed',
+                loggerCtx,
+                err.stack,
+            );
         }
 
         const config = {
             ...this.s3Config.nativeS3Configuration,
-            credentials: await this.getCredentials() // Avoid credentials overriden by nativeS3Configuration
-        } satisfies S3ClientConfig
+            credentials: await this.getCredentials(), // Avoid credentials overriden by nativeS3Configuration
+        } satisfies S3ClientConfig;
 
         this.s3Client = new this.AWS.S3Client(config);
 
@@ -206,7 +217,11 @@ export class S3AssetStorageStrategy implements AssetStorageStrategy {
         const body = await this.readFile(identifier);
 
         if (!body) {
-            return new Readable({ read() { this.push(null); } });
+            return new Readable({
+                read() {
+                    this.push(null);
+                },
+            });
         }
 
         return body;
@@ -220,7 +235,7 @@ export class S3AssetStorageStrategy implements AssetStorageStrategy {
     }
 
     private async writeFile(fileName: string, data: PutObjectRequest['Body'] | string | Uint8Array | Buffer) {
-        const { Upload } = this.libStorage
+        const { Upload } = this.libStorage;
 
         const upload = new Upload({
             client: this.s3Client,
@@ -232,7 +247,7 @@ export class S3AssetStorageStrategy implements AssetStorageStrategy {
             },
         });
 
-        return upload.done().then((result) => {
+        return upload.done().then(result => {
             if (!('Key' in result) || !result.Key) {
                 Logger.error(`Got undefined Key for ${fileName}`, loggerCtx);
                 throw new Error(`Got undefined Key for ${fileName}`);
@@ -243,12 +258,12 @@ export class S3AssetStorageStrategy implements AssetStorageStrategy {
     }
 
     async deleteFile(identifier: string) {
-        const { DeleteObjectCommand } = this.AWS
+        const { DeleteObjectCommand } = this.AWS;
         await this.s3Client.send(new DeleteObjectCommand(this.getObjectParams(identifier)));
     }
 
     async fileExists(fileName: string) {
-        const { HeadObjectCommand } = this.AWS
+        const { HeadObjectCommand } = this.AWS;
 
         try {
             await this.s3Client.send(new HeadObjectCommand(this.getObjectParams(fileName)));
@@ -266,21 +281,27 @@ export class S3AssetStorageStrategy implements AssetStorageStrategy {
     }
 
     private async ensureBucket(bucket = this.s3Config.bucket) {
-        const { HeadBucketCommand, CreateBucketCommand } = this.AWS
+        const { HeadBucketCommand, CreateBucketCommand } = this.AWS;
 
         try {
             await this.s3Client.send(new HeadBucketCommand({ Bucket: bucket }));
             Logger.verbose(`Found S3 bucket "${bucket}"`, loggerCtx);
-            return
+            return;
         } catch (err: any) {
-            Logger.verbose(`Could not find bucket "${bucket}: ${JSON.stringify(err.message)}". Attempting to create...`);
+            Logger.verbose(
+                `Could not find bucket "${bucket}: ${JSON.stringify(err.message)}". Attempting to create...`,
+            );
         }
 
         try {
-            await this.s3Client.send(new CreateBucketCommand({Bucket: bucket, ACL: 'private'}));
+            await this.s3Client.send(new CreateBucketCommand({ Bucket: bucket, ACL: 'private' }));
             Logger.verbose(`Created S3 bucket "${bucket}"`, loggerCtx);
         } catch (err: any) {
-            Logger.error(`Could not find nor create the S3 bucket "${bucket}: ${JSON.stringify(err.message)}"`, loggerCtx, err.stack);
+            Logger.error(
+                `Could not find nor create the S3 bucket "${bucket}: ${JSON.stringify(err.message)}"`,
+                loggerCtx,
+                err.stack,
+            );
         }
     }
 
@@ -292,16 +313,25 @@ export class S3AssetStorageStrategy implements AssetStorageStrategy {
         if (this.isCredentialsProfile(this.s3Config.credentials)) {
             Logger.warn(
                 'The "profile" property of the "s3Config.credentials" is deprecated. ' +
-                'Please use the "fromIni()" function from the "@aws-sdk/credential-provider-ini" or "@aws-sdk/credential-providers" package instead.',
-                loggerCtx
+                    'Please use the "fromIni()" function from the "@aws-sdk/credential-provider-ini" or "@aws-sdk/credential-providers" package instead.',
+                loggerCtx,
             );
-            return (await import('@aws-sdk/credential-provider-ini')).fromIni({ profile: this.s3Config.credentials.profile  });
+            return (await import('@aws-sdk/credential-provider-ini')).fromIni({
+                profile: this.s3Config.credentials.profile,
+            });
         }
 
-        return this.s3Config.credentials
+        return this.s3Config.credentials;
     }
 
-    private isCredentialsProfile(credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,): credentials is AwsCredentialIdentity & { profile: string } {
-        return credentials !== null && typeof credentials === 'object' && 'profile' in credentials && Object.keys(credentials).length === 1;
+    private isCredentialsProfile(
+        credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider,
+    ): credentials is AwsCredentialIdentity & { profile: string } {
+        return (
+            credentials !== null &&
+            typeof credentials === 'object' &&
+            'profile' in credentials &&
+            Object.keys(credentials).length === 1
+        );
     }
 }

packages/asset-server-plugin/src/sharp-asset-preview-strategy.ts

@@ -11,7 +11,7 @@ import { loggerCtx } from './constants';
  * preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
  * overlay will be generated.
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  * @docsPage SharpAssetPreviewStrategy
  */
 interface SharpAssetPreviewConfig {
@@ -88,7 +88,7 @@ interface SharpAssetPreviewConfig {
  * }),
  * ```
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  * @docsPage SharpAssetPreviewStrategy
  * @docsWeight 0
  */

packages/asset-server-plugin/src/types.ts

@@ -16,7 +16,7 @@ export type ImageTransformFormat = 'jpg' | 'jpeg' | 'png' | 'webp' | 'avif';
  * * resize: Preserving aspect ratio, resizes the image to be as large as possible
  * while ensuring its dimensions are less than or equal to both those specified.
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  */
 export type ImageTransformMode = 'crop' | 'resize';
 
@@ -34,7 +34,7 @@ export type ImageTransformMode = 'crop' | 'resize';
  *
  * `http://localhost:3000/assets/some-asset.jpg?w=50&h=50&mode=crop`
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  */
 export interface ImageTransformPreset {
     name: string;
@@ -47,7 +47,7 @@ export interface ImageTransformPreset {
  * @description
  * A configuration option for the Cache-Control header in the AssetServerPlugin asset response.
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  */
 export type CacheConfig = {
     /**
@@ -67,7 +67,7 @@ export type CacheConfig = {
  * @description
  * The configuration options for the AssetServerPlugin.
  *
- * @docsCategory AssetServerPlugin
+ * @docsCategory core plugins/AssetServerPlugin
  */
 export interface AssetServerOptions {
     /**

packages/common/src/shared-types.ts

@@ -211,7 +211,7 @@ export type CustomFieldsObject = { [key: string]: any };
  * The values are loaded at run-time by the Admin UI app, and allow core configuration to be
  * managed without the need to re-build the application.
  *
- * @docsCategory AdminUiPlugin
+ * @docsCategory core plugins/AdminUiPlugin
  */
 export interface AdminUiConfig {
     /**
@@ -328,7 +328,7 @@ export interface AdminUiConfig {
  * @description
  * Configures the path to a custom-build of the Admin UI app.
  *
- * @docsCategory common
+ * @docsCategory core plugins/AdminUiPlugin
  */
 export interface AdminUiAppConfig {
     /**
@@ -356,7 +356,7 @@ export interface AdminUiAppConfig {
  * @description
  * Information about the Admin UI app dev server.
  *
- * @docsCategory common
+ * @docsCategory core plugins/AdminUiPlugin
  */
 export interface AdminUiAppDevModeConfig {
     /**

packages/core/src/api/decorators/relations.decorator.ts

@@ -128,7 +128,7 @@ const cache = new TtlCache({ cacheSize: 500, ttl: 5 * 60 * 1000 });
  * ```
  *
  * @docsCategory request
- * @docsPage Api Decorator
+ * @docsPage Relations Decorator
  * @since 1.6.0
  */
 export const Relations: <T extends VendureEntity>(data: FieldsDecoratorConfig<T>) => ParameterDecorator =

packages/core/src/bootstrap.ts

@@ -39,7 +39,7 @@ export type VendureBootstrapFunction = (config: VendureConfig) => Promise<INestA
  *     console.log(err);
  * });
  * ```
- * @docsCategory
+ * @docsCategory common
  * */
 export async function bootstrap(userConfig: Partial<VendureConfig>): Promise<INestApplication> {
     const config = await preBootstrapConfig(userConfig);

packages/core/src/config/catalog/default-product-variant-price-calculation-strategy.ts

@@ -13,7 +13,7 @@ import {
  * @description
  * A default ProductVariant price calculation function.
  *
- * @docsCategory tax
+ * @docsCategory products & stock
  */
 export class DefaultProductVariantPriceCalculationStrategy implements ProductVariantPriceCalculationStrategy {
     private taxRateService: TaxRateService;

packages/core/src/config/catalog/default-stock-display-strategy.ts

@@ -9,7 +9,7 @@ import { StockDisplayStrategy } from './stock-display-strategy';
  * Low stock is defined as a saleable stock level less than or equal to the `lowStockLevel` as passed in
  * to the constructor (defaults to `2`).
  *
- * @docsCategory configuration
+ * @docsCategory products & stock
  */
 export class DefaultStockDisplayStrategy implements StockDisplayStrategy {
     constructor(private lowStockLevel: number = 2) {}

packages/core/src/config/catalog/default-stock-location-strategy.ts

@@ -15,7 +15,7 @@ import { AvailableStock, LocationWithQuantity, StockLocationStrategy } from './s
  * The DefaultStockLocationStrategy is the default implementation of the {@link StockLocationStrategy}.
  * It assumes only a single StockLocation and that all stock is allocated from that location.
  *
- * @docsCategory catalog
+ * @docsCategory products & stock
  * @since 2.0.0
  */
 export class DefaultStockLocationStrategy implements StockLocationStrategy {

packages/core/src/config/catalog/product-variant-price-calculation-strategy.ts

@@ -8,7 +8,7 @@ import { Zone } from '../../entity/zone/zone.entity';
  * @description
  * Defines how ProductVariant are calculated based on the input price, tax zone and current request context.
  *
- * @docsCategory configuration
+ * @docsCategory  products & stock
  * @docsPage ProductVariantPriceCalculationStrategy
  */
 export interface ProductVariantPriceCalculationStrategy extends InjectableStrategy {
@@ -19,7 +19,7 @@ export interface ProductVariantPriceCalculationStrategy extends InjectableStrate
  * @description
  * The arguments passed the `calculate` method of the configured {@link ProductVariantPriceCalculationStrategy}.
  *
- * @docsCategory configuration
+ * @docsCategory products & stock
  * @docsPage ProductVariantPriceCalculationStrategy
  */
 export interface ProductVariantPriceCalculationArgs {

packages/core/src/config/catalog/stock-display-strategy.ts

@@ -9,7 +9,7 @@ import { ProductVariant } from '../../entity/product-variant/product-variant.ent
  * sensitive information. However, the storefront will usually want to display _some_ indication
  * of whether a given ProductVariant is in stock.
  *
- * @docsCategory configuration
+ * @docsCategory products & stock
  */
 export interface StockDisplayStrategy extends InjectableStrategy {
     /**

packages/core/src/config/catalog/stock-location-strategy.ts

@@ -11,7 +11,7 @@ import { StockLocation } from '../../entity/stock-location/stock-location.entity
  * The overall available stock for a ProductVariant as determined by the logic of the
  * {@link StockLocationStrategy}'s `getAvailableStock` method.
  *
- * @docsCategory catalog
+ * @docsCategory products & stock
  * @since 2.0.0
  * @docsPage StockLocationStrategy
  */
@@ -25,7 +25,7 @@ export interface AvailableStock {
  * Returned by the `StockLocationStrategy` methods to indicate how much stock from each
  * location should be used in the allocation/sale/release/cancellation of an OrderLine.
  *
- * @docsCategory catalog
+ * @docsCategory products & stock
  * @since 2.0.0
  * @docsPage StockLocationStrategy
  */
@@ -41,7 +41,8 @@ export interface LocationWithQuantity {
  * from each location. It is also used to determine the available stock for a given
  * {@link ProductVariant}.
  *
- * @docsCategory catalog
+ * @docsCategory products & stock
+ * @docsWeight 0
  * @since 2.0.0
  */
 export interface StockLocationStrategy extends InjectableStrategy {

packages/core/src/config/vendure-config.ts

@@ -647,7 +647,7 @@ export interface AssetOptions {
  * @description
  * Options related to products and collections.
  *
- * @docsCategory configuration
+ * @docsCategory products & stock
  */
 export interface CatalogOptions {
     /**

packages/core/src/i18n/i18n.service.ts

@@ -18,7 +18,8 @@ import { I18nError } from './i18n-error';
  * @description
  * I18n resources used for translations
  *
- * @docsCategory Translation
+ * @docsCategory common
+ * @docsPage I18nService
  */
 export interface VendureTranslationResources {
     error: any;
@@ -35,7 +36,10 @@ export interface I18nRequest extends Request {
  * The `i18next-express-middleware` middleware detects the client's preferred language based on
  * the `Accept-Language` header or "lang" query param and adds language-specific translation
  * functions to the Express request / response objects.
- * @docsCategory Translation
+ *
+ * @docsCategory common
+ * @docsPage I18nService
+ * @docsWeight 0
  */
 @Injectable()
 export class I18nService implements OnModuleInit {

packages/core/src/plugin/default-search-plugin/default-search-plugin.ts

@@ -64,7 +64,7 @@ export interface DefaultSearchReindexResponse extends SearchReindexResponse {
  * };
  * ```
  *
- * @docsCategory DefaultSearchPlugin
+ * @docsCategory core plugins/DefaultSearchPlugin
  */
 @VendurePlugin({
     imports: [PluginCommonModule],

packages/core/src/plugin/default-search-plugin/types.ts

@@ -10,7 +10,7 @@ import { SearchStrategy } from './search-strategy/search-strategy';
  * @description
  * Options which configure the behaviour of the DefaultSearchPlugin
  *
- * @docsCategory DefaultSearchPlugin
+ * @docsCategory core plugins/DefaultSearchPlugin
  */
 export interface DefaultSearchPluginInitOptions {
     /**

packages/core/src/service/services/order.service.ts

@@ -167,7 +167,7 @@ export class OrderService {
     /**
      * @description
      * Returns an array of all the configured states and transitions of the order process. This is
-     * based on the default order process plus all configured {@link CustomOrderProcess} objects
+     * based on the default order process plus all configured {@link OrderProcess} objects
      * defined in the {@link OrderOptions} `process` array.
      */
     getOrderProcessStates(): OrderProcessState[] {

packages/dev-server/dev-config.ts

@@ -63,26 +63,43 @@ export const devConfig: VendureConfig = {
     },
 
     customFields: {
-        // ProductVariant: [
-        //     {
-        //         name: 'weight',
-        //         type: 'int',
-        //         defaultValue: 0,
-        //         nullable: false,
-        //         min: 0,
-        //         step: 1,
-        //         public: true,
-        //         label: [{ languageCode: LanguageCode.en, value: 'Weight' }],
-        //         ui: { component: 'number-form-input', suffix: 'g' },
-        //     },
-        //     {
-        //         name: 'gtin',
-        //         type: 'string',
-        //         nullable: true,
-        //         public: true,
-        //         label: [{ languageCode: LanguageCode.en, value: 'GTIN (barcode)' }],
-        //     },
-        // ],
+        Product: [
+            {
+                name: 'searchKeywords',
+                label: [{ languageCode: LanguageCode.en, value: 'Search keywords' }],
+                type: 'string',
+                defaultValue: '',
+                public: false,
+            },
+            {
+                name: 'noIndex',
+                label: [{ languageCode: LanguageCode.en, value: 'Do not allow crawlers to index' }],
+                type: 'boolean',
+                defaultValue: false,
+                public: true,
+                ui: { tab: 'SEO' },
+            },
+        ],
+        ProductVariant: [
+            {
+                name: 'weight',
+                type: 'int',
+                defaultValue: 0,
+                nullable: false,
+                min: 0,
+                step: 1,
+                public: true,
+                label: [{ languageCode: LanguageCode.en, value: 'Weight' }],
+                ui: { component: 'number-form-input', suffix: 'g' },
+            },
+            {
+                name: 'gtin',
+                type: 'string',
+                nullable: true,
+                public: true,
+                label: [{ languageCode: LanguageCode.en, value: 'GTIN (barcode)' }],
+            },
+        ],
     },
 
     /* customFields: {
@@ -395,53 +412,53 @@ export const devConfig: VendureConfig = {
             route: 'admin',
             port: 5001,
             // Un-comment to compile a custom admin ui
-            app: compileUiExtensions({
-                outputPath: path.join(__dirname, './custom-admin-ui'),
-                extensions: [
-                    {
-                        id: 'test-ui-extension',
-                        extensionPath: path.join(__dirname, 'test-plugins/with-ui-extension/ui'),
-                        ngModules: [
-                            {
-                                type: 'lazy',
-                                route: 'greetz',
-                                ngModuleFileName: 'greeter.module.ts',
-                                ngModuleName: 'GreeterModule',
-                            },
-                            {
-                                type: 'shared',
-                                ngModuleFileName: 'greeter-shared.module.ts',
-                                ngModuleName: 'GreeterSharedModule',
-                            },
-                        ],
-                    },
-                    {
-                        globalStyles: path.join(
-                            __dirname,
-                            'test-plugins/with-ui-extension/ui/custom-theme.scss',
-                        ),
-                    },
-                    {
-                        id: 'external-ui-extension',
-                        extensionPath: path.join(__dirname, 'test-plugins/with-external-ui-extension'),
-                        ngModules: [
-                            {
-                                type: 'lazy',
-                                route: 'greet',
-                                ngModuleFileName: 'external-ui-extension.ts',
-                                ngModuleName: 'ExternalUiExtensionModule',
-                            },
-                        ],
-                        staticAssets: [
-                            {
-                                path: path.join(__dirname, 'test-plugins/with-external-ui-extension/app'),
-                                rename: 'external-app',
-                            },
-                        ],
-                    },
-                ],
-                devMode: true,
-            }),
+            // app: compileUiExtensions({
+            //     outputPath: path.join(__dirname, './custom-admin-ui'),
+            //     extensions: [
+            //         {
+            //             id: 'test-ui-extension',
+            //             extensionPath: path.join(__dirname, 'test-plugins/with-ui-extension/ui'),
+            //             ngModules: [
+            //                 {
+            //                     type: 'lazy',
+            //                     route: 'greetz',
+            //                     ngModuleFileName: 'greeter.module.ts',
+            //                     ngModuleName: 'GreeterModule',
+            //                 },
+            //                 {
+            //                     type: 'shared',
+            //                     ngModuleFileName: 'greeter-shared.module.ts',
+            //                     ngModuleName: 'GreeterSharedModule',
+            //                 },
+            //             ],
+            //         },
+            //         {
+            //             globalStyles: path.join(
+            //                 __dirname,
+            //                 'test-plugins/with-ui-extension/ui/custom-theme.scss',
+            //             ),
+            //         },
+            //         {
+            //             id: 'external-ui-extension',
+            //             extensionPath: path.join(__dirname, 'test-plugins/with-external-ui-extension'),
+            //             ngModules: [
+            //                 {
+            //                     type: 'lazy',
+            //                     route: 'greet',
+            //                     ngModuleFileName: 'external-ui-extension.ts',
+            //                     ngModuleName: 'ExternalUiExtensionModule',
+            //                 },
+            //             ],
+            //             staticAssets: [
+            //                 {
+            //                     path: path.join(__dirname, 'test-plugins/with-external-ui-extension/app'),
+            //                     rename: 'external-app',
+            //                 },
+            //             ],
+            //         },
+            //     ],
+            //     devMode: true,
+            // }),
         }),
     ],
 };
@@ -480,7 +497,7 @@ function getDbConfig(): DataSourceOptions {
         default:
             console.log('Using mysql connection');
             return {
-                synchronize: false,
+                synchronize: true,
                 type: 'mariadb',
                 host: '127.0.0.1',
                 port: 3306,

packages/elasticsearch-plugin/src/options.ts

@@ -16,7 +16,7 @@ import {
  * @description
  * Configuration options for the {@link ElasticsearchPlugin}.
  *
- * @docsCategory ElasticsearchPlugin
+ * @docsCategory core plugins/ElasticsearchPlugin
  * @docsPage ElasticsearchOptions
  */
 export interface ElasticsearchOptions {
@@ -371,7 +371,7 @@ export interface ElasticsearchOptions {
  * @description
  * Configuration options for the internal Elasticsearch query which is generated when performing a search.
  *
- * @docsCategory ElasticsearchPlugin
+ * @docsCategory core plugins/ElasticsearchPlugin
  * @docsPage ElasticsearchOptions
  */
 export interface SearchConfig {
@@ -656,7 +656,7 @@ export interface SearchConfig {
  *
  * Boosting a field acts as a score multiplier for matches against that field.
  *
- * @docsCategory ElasticsearchPlugin
+ * @docsCategory core plugins/ElasticsearchPlugin
  * @docsPage ElasticsearchOptions
  */
 export interface BoostFieldsConfig {

packages/elasticsearch-plugin/src/plugin.ts

@@ -217,7 +217,7 @@ function getCustomResolvers(options: ElasticsearchRuntimeOptions) {
  *}
  * ```
  *
- * @docsCategory ElasticsearchPlugin
+ * @docsCategory core plugins/ElasticsearchPlugin
  */
 @VendurePlugin({
     imports: [PluginCommonModule],

packages/email-plugin/src/email-generator.ts

@@ -6,7 +6,7 @@ import { EmailDetails, EmailPluginOptions } from './types';
  * @description
  * An EmailGenerator generates the subject and body details of an email.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage EmailGenerator
  * @docsWeight 0
  */

packages/email-plugin/src/email-sender.ts

@@ -38,7 +38,7 @@ import { EmailDetails, EmailTransportOptions } from './types';
  * };
  * ```
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage EmailSender
  * @docsWeight 0
  */

packages/email-plugin/src/event-handler.ts

@@ -126,7 +126,7 @@ import {
  * };
  * ```
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  */
 export class EmailEventHandler<T extends string = string, Event extends EventWithContext = EventWithContext> {
     private setRecipientFn: (event: Event) => string;
@@ -144,7 +144,7 @@ export class EmailEventHandler<T extends string = string, Event extends EventWit
     };
     private _mockEvent: Omit<Event, 'ctx' | 'data'> | undefined;
 
-    constructor(public listener: EmailEventListener<T>, public event: Type<Event>) { }
+    constructor(public listener: EmailEventListener<T>, public event: Type<Event>) {}
 
     /** @internal */
     get type(): T {
@@ -268,7 +268,7 @@ export class EmailEventHandler<T extends string = string, Event extends EventWit
      * @description
      * Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
      * templates for channels or languageCodes other than the default.
-     * 
+     *
      * @deprecated Define a custom TemplateLoader on plugin initalization to define templates based on the RequestContext.
      * E.g. `EmailPlugin.init({ templateLoader: new CustomTemplateLoader() })`
      */
@@ -350,13 +350,13 @@ export class EmailEventHandler<T extends string = string, Event extends EventWit
         if (!this.setRecipientFn) {
             throw new Error(
                 `No setRecipientFn has been defined. ` +
-                `Remember to call ".setRecipient()" when setting up the EmailEventHandler for ${this.type}`,
+                    `Remember to call ".setRecipient()" when setting up the EmailEventHandler for ${this.type}`,
             );
         }
         if (this.from === undefined) {
             throw new Error(
                 `No from field has been defined. ` +
-                `Remember to call ".setFrom()" when setting up the EmailEventHandler for ${this.type}`,
+                    `Remember to call ".setFrom()" when setting up the EmailEventHandler for ${this.type}`,
             );
         }
         const { ctx } = event;
@@ -366,7 +366,7 @@ export class EmailEventHandler<T extends string = string, Event extends EventWit
         if (subject == null) {
             throw new Error(
                 `No subject field has been defined. ` +
-                `Remember to call ".setSubject()" when setting up the EmailEventHandler for ${this.type}`,
+                    `Remember to call ".setSubject()" when setting up the EmailEventHandler for ${this.type}`,
             );
         }
         const recipient = this.setRecipientFn(event);
@@ -433,7 +433,7 @@ export class EmailEventHandler<T extends string = string, Event extends EventWit
  * Identical to the {@link EmailEventHandler} but with a `data` property added to the `event` based on the result
  * of the `.loadData()` function.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  */
 export class EmailEventHandlerWithAsyncData<
     Data,

packages/email-plugin/src/event-listener.ts

@@ -8,7 +8,7 @@ import { EventWithContext } from './types';
  * An EmailEventListener is used to listen for events and set up a {@link EmailEventHandler} which
  * defines how an email will be generated from this event.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  */
 export class EmailEventListener<T extends string> {
     public type: T;

packages/email-plugin/src/handlebars-mjml-generator.ts

@@ -17,7 +17,7 @@ import {
  * Uses Handlebars (https://handlebarsjs.com/) to output MJML (https://mjml.io) which is then
  * compiled down to responsive email HTML.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage EmailGenerator
  */
 export class HandlebarsMjmlGenerator implements EmailGenerator {

packages/email-plugin/src/nodemailer-email-sender.ts

@@ -17,7 +17,7 @@ import {
     SendmailTransportOptions,
     SESTransportOptions,
     SMTPTransportOptions,
-} from './types'
+} from './types';
 
 export type StreamTransportInfo = {
     envelope: {
@@ -32,13 +32,13 @@ export type StreamTransportInfo = {
  * @description
  * Uses the configured transport to send the generated email.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage EmailSender
  */
 export class NodemailerEmailSender implements EmailSender {
     private _smtpTransport: Mail | undefined;
     private _sendMailTransport: Mail | undefined;
-    private _sesTransport: Mail |undefined
+    private _sesTransport: Mail | undefined;
 
     async send(email: EmailDetails, options: EmailTransportOptions) {
         switch (options.type) {

packages/email-plugin/src/plugin.ts

@@ -272,7 +272,7 @@ import {
  * };
  * ```
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  */
 @VendurePlugin({
     imports: [PluginCommonModule],

packages/email-plugin/src/types.ts

@@ -2,7 +2,7 @@ import { LanguageCode } from '@vendure/common/lib/generated-types';
 import { Omit } from '@vendure/common/lib/omit';
 import { Injector, RequestContext, SerializedRequestContext, VendureEvent } from '@vendure/core';
 import { Attachment } from 'nodemailer/lib/mailer';
-import SESTransport from 'nodemailer/lib/ses-transport'
+import SESTransport from 'nodemailer/lib/ses-transport';
 import SMTPTransport from 'nodemailer/lib/smtp-transport';
 
 import { EmailGenerator } from './email-generator';
@@ -15,7 +15,7 @@ import { EmailEventHandler } from './event-handler';
  * {@link RequestContext}, which is used to determine the channel and language
  * to use when generating the email.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export type EventWithContext = VendureEvent & { ctx: RequestContext };
@@ -25,7 +25,7 @@ export type EventWithContext = VendureEvent & { ctx: RequestContext };
  * A VendureEvent with a {@link RequestContext} and a `data` property which contains the
  * value resolved from the {@link EmailEventHandler}`.loadData()` callback.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export type EventWithAsyncData<Event extends EventWithContext, R> = Event & { data: R };
@@ -34,7 +34,7 @@ export type EventWithAsyncData<Event extends EventWithContext, R> = Event & { da
  * @description
  * Configuration for the EmailPlugin.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage EmailPluginOptions
  * */
 export interface EmailPluginOptions {
@@ -42,7 +42,7 @@ export interface EmailPluginOptions {
      * @description
      * The path to the location of the email templates. In a default Vendure installation,
      * the templates are installed to `<project root>/vendure/email/templates`.
-     * 
+     *
      * @deprecated Use `templateLoader` to define a template path: `templateLoader: new FileBasedTemplateLoader('../your-path/templates')`
      */
     templatePath?: string;
@@ -58,7 +58,12 @@ export interface EmailPluginOptions {
      * @description
      * Configures how the emails are sent.
      */
-    transport: EmailTransportOptions | ((injector?: Injector, ctx?: RequestContext) => EmailTransportOptions | Promise<EmailTransportOptions>)
+    transport:
+        | EmailTransportOptions
+        | ((
+              injector?: Injector,
+              ctx?: RequestContext,
+          ) => EmailTransportOptions | Promise<EmailTransportOptions>);
     /**
      * @description
      * An array of {@link EmailEventHandler}s which define which Vendure events will trigger
@@ -99,7 +104,7 @@ export type InitializedEmailPluginOptions = EmailPluginOptions & { templateLoade
  * @description
  * Configuration for running the EmailPlugin in development mode.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage EmailPluginOptions
  */
 export interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'> {
@@ -120,7 +125,7 @@ export interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'tra
  * @description
  * A union of all the possible transport options for sending emails.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Transport Options
  */
 export type EmailTransportOptions =
@@ -135,7 +140,7 @@ export type EmailTransportOptions =
  * @description
  * The SMTP transport options of [Nodemailer](https://nodemailer.com/smtp/)
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Transport Options
  */
 export interface SMTPTransportOptions extends SMTPTransport.Options {
@@ -184,7 +189,7 @@ export interface SMTPTransportOptions extends SMTPTransport.Options {
  *   ],
  * };
  *  ```
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Transport Options
  */
 export interface SESTransportOptions extends SESTransport.Options {
@@ -195,7 +200,7 @@ export interface SESTransportOptions extends SESTransport.Options {
  * @description
  * Uses the local Sendmail program to send the email.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Transport Options
  */
 export interface SendmailTransportOptions {
@@ -210,7 +215,7 @@ export interface SendmailTransportOptions {
  * @description
  * Outputs the email as an HTML file for development purposes.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Transport Options
  */
 export interface FileTransportOptions {
@@ -226,7 +231,7 @@ export interface FileTransportOptions {
  * Does nothing with the generated email. Intended for use in testing where we don't care about the email transport,
  * or when using a custom {@link EmailSender} which does not require transport options.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Transport Options
  */
 export interface NoopTransportOptions {
@@ -237,7 +242,7 @@ export interface NoopTransportOptions {
  * @description
  * The final, generated email details to be sent.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialized'> {
@@ -255,7 +260,7 @@ export interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unse
  * @description
  * Forwards the raw GeneratedEmailContext object to a provided callback, for use in testing.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Transport Options
  */
 export interface TestingTransportOptions {
@@ -271,7 +276,7 @@ export interface TestingTransportOptions {
  * @description
  * A function used to load async data for use by an {@link EmailEventHandler}.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export type LoadDataFn<Event extends EventWithContext, R> = (context: {
@@ -290,7 +295,7 @@ export type OptionalToNullable<O> = {
  * only uses the `path` property to define a filesystem path or a URL pointing to
  * the attachment file.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export type EmailAttachment = Omit<Attachment, 'raw'> & { path?: string };
@@ -317,8 +322,8 @@ export type IntermediateEmailDetails = {
  * @description
  * Configures the {@link EmailEventHandler} to handle a particular channel & languageCode
  * combination.
- * 
- * @deprecated Use a custom {@link TemplateLoader} instead. 
+ *
+ * @deprecated Use a custom {@link TemplateLoader} instead.
  */
 export interface EmailTemplateConfig {
     /**
@@ -347,30 +352,30 @@ export interface EmailTemplateConfig {
 }
 
 export interface LoadTemplateInput {
-    type: string,
-    templateName: string
+    type: string;
+    templateName: string;
 }
 
 export interface Partial {
-    name: string,
-    content: string
+    name: string;
+    content: string;
 }
 
 /**
  * @description
  * Load an email template based on the given request context, type and template name
  * and return the template as a string.
- * 
+ *
  * @example
  * ```TypeScript
  * import { EmailPlugin, TemplateLoader } from '@vendure/email-plugin';
- * 
+ *
  * class MyTemplateLoader implements TemplateLoader {
  *      loadTemplate(injector, ctx, { type, templateName }){
  *          return myCustomTemplateFunction(ctx);
  *      }
  * }
- * 
+ *
  * // In vendure-config.ts:
  * ...
  * EmailPlugin.init({
@@ -379,7 +384,7 @@ export interface Partial {
  * })
  * ```
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Custom Template Loader
  */
 export interface TemplateLoader {
@@ -388,8 +393,8 @@ export interface TemplateLoader {
      */
     loadTemplate(injector: Injector, ctx: RequestContext, input: LoadTemplateInput): Promise<string>;
     /**
-     * Load partials and return their contents. 
-     * This method is only called during initalization, i.e. during server startup. 
+     * Load partials and return their contents.
+     * This method is only called during initalization, i.e. during server startup.
      */
     loadPartials?(): Promise<Partial[]>;
 }
@@ -399,7 +404,7 @@ export interface TemplateLoader {
  * A function used to define template variables available to email templates.
  * See {@link EmailEventHandler}.setTemplateVars().
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export type SetTemplateVarsFn<Event> = (
@@ -413,7 +418,7 @@ export type SetTemplateVarsFn<Event> = (
  * See https://nodemailer.com/message/attachments/ for more information about
  * how attachments work in Nodemailer.
  *
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Promise<EmailAttachment[]>;
@@ -423,7 +428,7 @@ export type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Prom
  * Optional address-related fields for sending the email.
  *
  * @since 1.1.0
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export interface OptionalAddressFields {
@@ -449,7 +454,7 @@ export interface OptionalAddressFields {
  * A function used to set the {@link OptionalAddressFields}.
  *
  * @since 1.1.0
- * @docsCategory EmailPlugin
+ * @docsCategory core plugins/EmailPlugin
  * @docsPage Email Plugin Types
  */
 export type SetOptionalAddressFieldsFn<Event> = (

packages/harden-plugin/src/harden.plugin.ts

@@ -137,7 +137,7 @@ import { HardenPluginOptions } from './types';
  * verbose 16/12/22, 14:12 - [HardenPlugin] Query complexity [ProductList]: 35
  * ```
  *
- * @docsCategory HardenPlugin
+ * @docsCategory core plugins/HardenPlugin
  */
 @VendurePlugin({
     providers: [

packages/harden-plugin/src/middleware/query-complexity-plugin.ts

@@ -90,7 +90,7 @@ function isAdminApi(schema: GraphQLSchema): boolean {
  * When selecting PaginatedList types, the "take" argument is used to estimate a complexity
  * factor. If the "take" argument is omitted, a default factor of 1000 is applied.
  *
- * @docsCategory HardenPlugin
+ * @docsCategory core plugins/HardenPlugin
  */
 export function defaultVendureComplexityEstimator(
     customComplexityFactors: { [path: string]: number },

packages/harden-plugin/src/types.ts

@@ -4,7 +4,7 @@ import { ComplexityEstimator } from 'graphql-query-complexity/dist/cjs/QueryComp
  * @description
  * Options that can be passed to the `.init()` static method of the HardenPlugin.
  *
- * @docsCategory HardenPlugin
+ * @docsCategory core plugins/HardenPlugin
  */
 export interface HardenPluginOptions {
     /**

packages/job-queue-plugin/src/bullmq/bullmq-job-queue-strategy.ts

@@ -26,7 +26,7 @@ const DEFAULT_CONCURRENCY = 3;
  * This JobQueueStrategy uses [BullMQ](https://docs.bullmq.io/) to implement a push-based job queue
  * on top of Redis. It should not be used alone, but as part of the {@link BullMQJobQueuePlugin}.
  *
- * @docsCategory job-queue-plugin
+ * @docsCategory core plugins/JobQueuePlugin
  */
 export class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
     private redisConnection: Redis | Cluster;

packages/job-queue-plugin/src/bullmq/plugin.ts

@@ -97,7 +97,7 @@ import { BullMQPluginOptions } from './types';
  * };
  * ```
  *
- * @docsCategory job-queue-plugin
+ * @docsCategory core plugins/JobQueuePlugin
  */
 @VendurePlugin({
     imports: [PluginCommonModule],

packages/job-queue-plugin/src/bullmq/types.ts

@@ -7,7 +7,7 @@ import { QueueOptions } from 'bullmq';
  * Configuration options for the {@link BullMQJobQueuePlugin}.
  *
  * @since 1.2.0
- * @docsCategory job-queue-plugin
+ * @docsCategory core plugins/JobQueuePlugin
  * @docsPage BullMQPluginOptions
  * @docsWeight 0
  */
@@ -84,7 +84,7 @@ export interface BullMQPluginOptions {
  * Configuration for the backoff function when retrying failed jobs.
  *
  * @since 1.3.0
- * @docsCategory job-queue-plugin
+ * @docsCategory core plugins/JobQueuePlugin
  * @docsPage BullMQPluginOptions
  * @docsWeight 1
  */

packages/payments-plugin/src/braintree/braintree.plugin.ts

@@ -235,7 +235,7 @@ import { BraintreePluginOptions } from './types';
  *   );
  * ```
  *
- * @docsCategory payments-plugin
+ * @docsCategory core plugins/PaymentsPlugin
  * @docsPage BraintreePlugin
  */
 @VendurePlugin({

packages/payments-plugin/src/braintree/types.ts

@@ -5,7 +5,7 @@ import { Environment, Transaction } from 'braintree';
 
 import { braintreePaymentMethodHandler } from './braintree.handler';
 
-export type PaymentMethodArgsHash = ConfigArgValues<typeof braintreePaymentMethodHandler['args']>;
+export type PaymentMethodArgsHash = ConfigArgValues<(typeof braintreePaymentMethodHandler)['args']>;
 
 // Note: deep import is necessary here because CustomCustomerFields is also extended in the Stripe
 // plugin. Reference: https://github.com/microsoft/TypeScript/issues/46617
@@ -19,7 +19,7 @@ declare module '@vendure/core/dist/entity/custom-entity-fields' {
  * @description
  * Options for the Braintree plugin.
  *
- * @docsCategory payments-plugin
+ * @docsCategory core plugins/PaymentsPlugin
  * @docsPage BraintreePlugin
  */
 export interface BraintreePluginOptions {

packages/payments-plugin/src/mollie/mollie.plugin.ts

@@ -11,7 +11,7 @@ import { MollieService } from './mollie.service';
  * @description
  * Configuration options for the Mollie payments plugin.
  *
- * @docsCategory payments-plugin
+ * @docsCategory core plugins/PaymentsPlugin
  * @docsPage MolliePlugin
  */
 export interface MolliePluginOptions {
@@ -26,9 +26,9 @@ export interface MolliePluginOptions {
      * @description
      * For backwards compatibility, by default set to false.
      * This option will be deprecated in a future version.
-     * When enabled, the `redirectUrl` can be passed via the `createPaymentIntent` mutation 
+     * When enabled, the `redirectUrl` can be passed via the `createPaymentIntent` mutation
      * instead of being configured in the Payment Method.
-     * 
+     *
      * @default false
      * @since 2.0.0
      */
@@ -67,15 +67,15 @@ export interface MolliePluginOptions {
  * 3. Set your Mollie apiKey in the `API Key` field.
  *
  * ## Specifying the redirectUrl
- * 
+ *
  * Currently, there are two ways to specify the `redirectUrl` to which the customer is redirected after completing the payment:
- * 1. Configure the `redirectUrl` in the PaymentMethod. 
+ * 1. Configure the `redirectUrl` in the PaymentMethod.
  * 2. Pass the `redirectUrl` as an argument to the `createPaymentIntent` mutation.
- * 
+ *
  * Which method is used depends on the value of the `useDynamicRedirectUrl` option while initializing the plugin.
  * By default, this option is set to `false` for backwards compatibility. In a future version, this option will be deprecated.
  * Upon deprecation, the `redirectUrl` will always be passed as an argument to the `createPaymentIntent` mutation.
- * 
+ *
  * TODO toevoegen van /code weggehaald..!
  * ## Storefront usage
  *
@@ -144,7 +144,7 @@ export interface MolliePluginOptions {
  * If you don't want this behaviour (Authorized first), you can set 'autoCapture=true' on the payment method. This option will immediately
  * capture the payment after a customer authorizes the payment.
  *
- * @docsCategory payments-plugin
+ * @docsCategory core plugins/PaymentsPlugin
  * @docsPage MolliePlugin
  * @docsWeight 0
  */

packages/payments-plugin/src/stripe/stripe.plugin.ts

@@ -153,7 +153,7 @@ import { StripePluginOptions } from './types';
  *    ```
  * 4. The Stripe CLI will create a webhook signing secret you can then use in your config of the StripePlugin.
  *
- * @docsCategory payments-plugin
+ * @docsCategory core plugins/PaymentsPlugin
  * @docsPage StripePlugin
  */
 @VendurePlugin({

packages/payments-plugin/src/stripe/types.ts

@@ -15,7 +15,7 @@ declare module '@vendure/core/dist/entity/custom-entity-fields' {
  * @description
  * Configuration options for the Stripe payments plugin.
  *
- * @docsCategory payments-plugin
+ * @docsCategory core plugins/PaymentsPlugin
  * @docsPage StripePlugin
  */
 export interface StripePluginOptions {

scripts/docs/generate-graphql-docs.ts

@@ -48,11 +48,11 @@ generateGraphqlDocs(outputPath);
 
 function generateGraphqlDocs(hugoOutputPath: string) {
     const timeStart = +new Date();
-    let queriesOutput = generateFrontMatter('Queries', 1) + `\n\n# Queries\n\n`;
-    let mutationsOutput = generateFrontMatter('Mutations', 2) + `\n\n# Mutations\n\n`;
-    let objectTypesOutput = generateFrontMatter('Types', 3) + `\n\n# Types\n\n`;
-    let inputTypesOutput = generateFrontMatter('Input Objects', 4) + `\n\n# Input Objects\n\n`;
-    let enumsOutput = generateFrontMatter('Enums', 5) + `\n\n# Enums\n\n`;
+    let queriesOutput = generateFrontMatter('Queries', 1) + '\n\n# Queries\n\n';
+    let mutationsOutput = generateFrontMatter('Mutations', 2) + '\n\n# Mutations\n\n';
+    let objectTypesOutput = generateFrontMatter('Types', 3) + '\n\n# Types\n\n';
+    let inputTypesOutput = generateFrontMatter('Input Objects', 4) + '\n\n# Input Objects\n\n';
+    let enumsOutput = generateFrontMatter('Enums', 5) + '\n\n# Enums\n\n';
     const sortByName = (a: { name: string }, b: { name: string }) => (a.name < b.name ? -1 : 1);
     const sortedTypes = Object.values(schema.getTypeMap()).sort(sortByName);
     for (const type of sortedTypes) {
@@ -81,7 +81,7 @@ function generateGraphqlDocs(hugoOutputPath: string) {
                 objectTypesOutput += `## ${type.name}\n\n`;
                 objectTypesOutput += renderDescription(type);
                 objectTypesOutput += renderFields(type);
-                objectTypesOutput += `\n`;
+                objectTypesOutput += '\n';
             }
         }
 
@@ -106,7 +106,7 @@ function generateGraphqlDocs(hugoOutputPath: string) {
             inputTypesOutput += `## ${type.name}\n\n`;
             inputTypesOutput += renderDescription(type);
             inputTypesOutput += renderFields(type);
-            inputTypesOutput += `\n`;
+            inputTypesOutput += '\n';
         }
 
         if (isUnionType(type)) {
@@ -203,7 +203,7 @@ function unwrapType(type: GraphQLType): GraphQLNamedType {
     if (isNamedType(type)) {
         return type;
     }
-    let innerType = type;
+    let innerType = type as GraphQLType;
     while (!isNamedType(innerType)) {
         innerType = innerType.ofType;
     }
@@ -213,7 +213,7 @@ function unwrapType(type: GraphQLType): GraphQLNamedType {
 function getTargetApiFromArgs(): TargetApi {
     const apiArg = process.argv.find(arg => /--api=(shop|admin)/.test(arg));
     if (!apiArg) {
-        console.error(`\nPlease specify which GraphQL API to generate docs for: --api=<shop|admin>\n`);
+        console.error('\nPlease specify which GraphQL API to generate docs for: --api=<shop|admin>\n');
         process.exit(1);
         return null as never;
     }

scripts/docs/generate-typescript-docs.ts

@@ -84,7 +84,7 @@ function generateTypescriptDocs(config: DocsSectionConfig[], isWatchMode: boolea
                 globalTypeMap.set(declaration.title, pathToTypeDoc);
             }
         }
-        const docsUrl = `/docs`;
+        const docsUrl = ``;
         const generatedCount = new TypescriptDocsRenderer().render(
             docsPages,
             docsUrl,

scripts/docs/typescript-docgen-types.ts

@@ -29,7 +29,7 @@ export interface MethodInfo extends MemberInfo {
 
 export interface DocsPage {
     title: string;
-    category: string;
+    category: string[];
     declarations: ParsedDeclaration[];
     fileName: string;
 }

scripts/docs/typescript-docs-parser.ts

@@ -20,7 +20,7 @@ import {
  */
 export class TypescriptDocsParser {
     private readonly atTokenPlaceholder = '__EscapedAtToken__';
-    private readonly commentBlockEndTokenPlaceholder = '__EscapedCommentBlockEndToken__'
+    private readonly commentBlockEndTokenPlaceholder = '__EscapedCommentBlockEndToken__';
 
     /**
      * Parses the TypeScript files given by the filePaths array and returns the
@@ -58,7 +58,7 @@ export class TypescriptDocsParser {
                     const fileName = normalizedTitle === declaration.category ? '_index' : normalizedTitle;
                     pages.set(pageTitle, {
                         title: pageTitle,
-                        category: declaration.category,
+                        category: declaration.category.split('/'),
                         declarations: [declaration],
                         fileName,
                     });
@@ -156,7 +156,7 @@ export class TypescriptDocsParser {
         } else if (ts.isEnumDeclaration(statement)) {
             return {
                 ...info,
-                kind: 'enum' as 'enum',
+                kind: 'enum' as const,
                 members: this.parseMembers(statement.members) as PropertyInfo[],
             };
         } else if (ts.isFunctionDeclaration(statement)) {
@@ -457,13 +457,17 @@ export class TypescriptDocsParser {
      * pattern in descriptions and therefore it is supported as long as the leading '/' is escaped ("\/").
      */
     private replaceEscapedTokens(content: string): string {
-        return content.replace(/\\@/g, this.atTokenPlaceholder).replace(/\\\/\*/g, this.commentBlockEndTokenPlaceholder);
+        return content
+            .replace(/\\@/g, this.atTokenPlaceholder)
+            .replace(/\\\/\*/g, this.commentBlockEndTokenPlaceholder);
     }
 
     /**
      * Restores "@" and "/*" tokens which were replaced by the replaceEscapedTokens() method.
      */
     private restoreTokens(content: string): string {
-        return content.replace(new RegExp(this.atTokenPlaceholder, 'g'), '@').replace(new RegExp(this.commentBlockEndTokenPlaceholder, 'g'), '/*');
+        return content
+            .replace(new RegExp(this.atTokenPlaceholder, 'g'), '@')
+            .replace(new RegExp(this.commentBlockEndTokenPlaceholder, 'g'), '/*');
     }
 }

scripts/docs/typescript-docs-renderer.ts

@@ -32,6 +32,7 @@ export class TypescriptDocsRenderer {
             markdown += `\n# ${page.title}\n`;
             const declarationsByWeight = page.declarations.sort((a, b) => a.weight - b.weight);
             for (const info of declarationsByWeight) {
+                markdown += '<div class="symbol">\n';
                 switch (info.kind) {
                     case 'interface':
                         markdown += this.renderInterfaceOrClass(info, typeMap, docsUrl);
@@ -54,19 +55,23 @@ export class TypescriptDocsRenderer {
                     default:
                         assertNever(info);
                 }
-                // markdown += '{{< /declaration >}}\n';
+                markdown += '</div>\n';
             }
 
-            const categoryDir = path.join(outputPath, page.category);
-            const indexFile = path.join(categoryDir, '_index.md');
+            const categoryDir = path.join(outputPath, ...page.category);
             if (!fs.existsSync(categoryDir)) {
                 fs.mkdirsSync(categoryDir);
             }
-            if (!fs.existsSync(indexFile)) {
-                const indexFileContent =
-                    generateFrontMatter(page.category, 10, false) + `\n\n# ${page.category}`;
-                fs.writeFileSync(indexFile, indexFileContent);
-                generatedCount++;
+            const pathParts = [];
+            for (const subCategory of page.category) {
+                pathParts.push(subCategory);
+                const indexFile = path.join(outputPath, ...pathParts, '_index.md');
+                if (!fs.existsSync(indexFile)) {
+                    const indexFileContent =
+                        generateFrontMatter(subCategory, 10, false) + `\n\n# ${subCategory}`;
+                    fs.writeFileSync(indexFile, indexFileContent);
+                    generatedCount++;
+                }
             }
 
             fs.writeFileSync(path.join(categoryDir, page.fileName + '.md'), markdown);
@@ -88,19 +93,19 @@ export class TypescriptDocsRenderer {
         output += `\n\n# ${title}\n\n`;
         output += this.renderGenerationInfoShortcode(info);
         output += `${this.renderDescription(description, knownTypeMap, docsUrl)}\n\n`;
-        output += `## Signature\n\n`;
+        output += '## Signature\n\n';
         output +=
             info.kind === 'interface' ? this.renderInterfaceSignature(info) : this.renderClassSignature(info);
         if (info.extendsClause) {
-            output += `## Extends\n\n`;
+            output += '## Extends\n\n';
             output += `${this.renderHeritageClause(info.extendsClause, knownTypeMap, docsUrl)}\n`;
         }
         if (info.kind === 'class' && info.implementsClause) {
-            output += `## Implements\n\n`;
+            output += '## Implements\n\n';
             output += `${this.renderHeritageClause(info.implementsClause, knownTypeMap, docsUrl)}\n`;
         }
         if (info.members && info.members.length) {
-            output += `## Members\n\n`;
+            output += '## Members\n\n';
             output += `${this.renderMembers(info, knownTypeMap, docsUrl)}\n`;
         }
         return output;
@@ -115,10 +120,10 @@ export class TypescriptDocsRenderer {
         output += `\n\n# ${title}\n\n`;
         output += this.renderGenerationInfoShortcode(typeAliasInfo);
         output += `${this.renderDescription(description, knownTypeMap, docsUrl)}\n\n`;
-        output += `## Signature\n\n`;
+        output += '## Signature\n\n';
         output += this.renderTypeAliasSignature(typeAliasInfo);
         if (typeAliasInfo.members && typeAliasInfo.members.length) {
-            output += `## Members\n\n`;
+            output += '## Members\n\n';
             output += `${this.renderMembers(typeAliasInfo, knownTypeMap, docsUrl)}\n`;
         }
         return output;
@@ -130,7 +135,7 @@ export class TypescriptDocsRenderer {
         output += `\n\n# ${title}\n\n`;
         output += this.renderGenerationInfoShortcode(enumInfo);
         output += `${this.renderDescription(description, knownTypeMap, docsUrl)}\n\n`;
-        output += `## Signature\n\n`;
+        output += '## Signature\n\n';
         output += this.renderEnumSignature(enumInfo);
         return output;
     }
@@ -141,10 +146,10 @@ export class TypescriptDocsRenderer {
         output += `\n\n# ${title}\n\n`;
         output += this.renderGenerationInfoShortcode(functionInfo);
         output += `${this.renderDescription(description, knownTypeMap, docsUrl)}\n\n`;
-        output += `## Signature\n\n`;
+        output += '## Signature\n\n';
         output += this.renderFunctionSignature(functionInfo, knownTypeMap);
         if (parameters.length) {
-            output += `## Parameters\n\n`;
+            output += '## Parameters\n\n';
             output += this.renderFunctionParams(parameters, knownTypeMap, docsUrl);
         }
         return output;
@@ -165,15 +170,15 @@ export class TypescriptDocsRenderer {
     private renderInterfaceSignature(interfaceInfo: InterfaceInfo): string {
         const { fullText, members } = interfaceInfo;
         let output = '';
-        output += `\`\`\`TypeScript\n`;
+        output += '```TypeScript\n';
         output += `interface ${fullText} `;
         if (interfaceInfo.extendsClause) {
             output += interfaceInfo.extendsClause.getText() + ' ';
         }
-        output += `{\n`;
-        output += members.map(member => `  ${member.fullText}`).join(`\n`);
-        output += `\n}\n`;
-        output += `\`\`\`\n`;
+        output += '{\n';
+        output += members.map(member => `  ${member.fullText}`).join('\n');
+        output += '\n}\n';
+        output += '```\n';
 
         return output;
     }
@@ -181,7 +186,7 @@ export class TypescriptDocsRenderer {
     private renderClassSignature(classInfo: ClassInfo): string {
         const { fullText, members } = classInfo;
         let output = '';
-        output += `\`\`\`TypeScript\n`;
+        output += '```TypeScript\n';
         output += `class ${fullText} `;
         if (classInfo.extendsClause) {
             output += classInfo.extendsClause.getText() + ' ';
@@ -189,7 +194,7 @@ export class TypescriptDocsRenderer {
         if (classInfo.implementsClause) {
             output += classInfo.implementsClause.getText() + ' ';
         }
-        output += `{\n`;
+        output += '{\n';
         const renderModifiers = (modifiers: string[]) => (modifiers.length ? modifiers.join(' ') + ' ' : '');
         output += members
             .map(member => {
@@ -206,9 +211,9 @@ export class TypescriptDocsRenderer {
                     return `  ${renderModifiers(member.modifiers)}${member.fullText}`;
                 }
             })
-            .join(`\n`);
-        output += `\n}\n`;
-        output += `\`\`\`\n`;
+            .join('\n');
+        output += '\n}\n';
+        output += '```\n';
 
         return output;
     }
@@ -216,36 +221,36 @@ export class TypescriptDocsRenderer {
     private renderTypeAliasSignature(typeAliasInfo: TypeAliasInfo): string {
         const { fullText, members, type } = typeAliasInfo;
         let output = '';
-        output += `\`\`\`TypeScript\n`;
+        output += '```TypeScript\n';
         output += `type ${fullText} = `;
         if (members) {
-            output += `{\n`;
-            output += members.map(member => `  ${member.fullText}`).join(`\n`);
-            output += `\n}\n`;
+            output += '{\n';
+            output += members.map(member => `  ${member.fullText}`).join('\n');
+            output += '\n}\n';
         } else {
-            output += type.getText() + `\n`;
+            output += type.getText() + '\n';
         }
-        output += `\`\`\`\n`;
+        output += '```\n';
         return output;
     }
 
     private renderEnumSignature(enumInfo: EnumInfo): string {
         const { fullText, members } = enumInfo;
         let output = '';
-        output += `\`\`\`TypeScript\n`;
+        output += '```TypeScript\n';
         output += `enum ${fullText} `;
         if (members) {
-            output += `{\n`;
+            output += '{\n';
             output += members
                 .map(member => {
                     let line = member.description ? `  // ${member.description}\n` : '';
                     line += `  ${member.fullText}`;
                     return line;
                 })
-                .join(`\n`);
-            output += `\n}\n`;
+                .join('\n');
+            output += '\n}\n';
         }
-        output += `\`\`\`\n`;
+        output += '```\n';
         return output;
     }
 
@@ -253,9 +258,9 @@ export class TypescriptDocsRenderer {
         const { fullText, parameters, type } = functionInfo;
         const args = parameters.map(p => this.renderParameter(p, p.type)).join(', ');
         let output = '';
-        output += `\`\`\`TypeScript\n`;
+        output += '```TypeScript\n';
         output += `function ${fullText}(${args}): ${type ? type.getText() : 'void'}\n`;
-        output += `\`\`\`\n`;
+        output += '```\n';
         return output;
     }
 
@@ -307,7 +312,7 @@ export class TypescriptDocsRenderer {
                 experimentalParam = 'experimental="true"';
             }
             output += `### ${member.name}\n\n`;
-            output += `{{< member-info kind="${[...member.modifiers, member.kind].join(
+            output += `{{< member-info kind="${[member.kind].join(
                 ' ',
             )}" type="${type}" ${defaultParam} ${sinceParam}${experimentalParam}>}}\n\n`;
             output += `{{< member-description >}}${this.renderDescription(
@@ -340,7 +345,7 @@ export class TypescriptDocsRenderer {
         }
         let experimental = '';
         if (info.experimental) {
-            experimental = ` experimental="true"`;
+            experimental = ' experimental="true"';
         }
         return `{{< generation-info sourceFile="${sourceFile}" sourceLine="${info.sourceLine}" packageName="${info.packageName}"${sinceData}${experimental}>}}\n\n`;
     }