@vendure/docs 0.0.0-202601210957 → 0.0.0-202601211028

package/docs/reference/typescript-api/events/vendure-entity-event.mdx

@@ -2,10 +2,6 @@
 title: "VendureEntityEvent"
 generated: true
 ---
-
-
-## VendureEntityEvent
-
 <GenerationInfo sourceFile="packages/core/src/event-bus/vendure-entity-event.ts" sourceLine="12" packageName="@vendure/core" />
 
 The base class for all entity events used by the EventBus system.

package/docs/reference/typescript-api/events/vendure-event.mdx

@@ -2,10 +2,6 @@
 title: "VendureEvent"
 generated: true
 ---
-
-
-## VendureEvent
-
 <GenerationInfo sourceFile="packages/core/src/event-bus/vendure-event.ts" sourceLine="7" packageName="@vendure/core" />
 
 The base class for all events used by the EventBus system.

package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx

@@ -2,13 +2,9 @@
 title: "FulfillmentHandler"
 generated: true
 ---
-
-
-## FulfillmentHandler
-
 <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="149" packageName="@vendure/core" />
 
-A FulfillmentHandler is used when creating a new <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>. When the `addFulfillmentToOrder` mutation
+A FulfillmentHandler is used when creating a new <DocsLink href="/reference/typescript-api/entities/fulfillment#fulfillment">Fulfillment</DocsLink>. When the `addFulfillmentToOrder` mutation
 is executed, the specified handler will be used and it's `createFulfillment` method is called. This method
 may perform async tasks such as calling a 3rd-party shipping API to register a new shipment and receive
 a tracking code. This data can then be returned and will be incorporated into the created Fulfillment.
@@ -101,13 +97,9 @@ class FulfillmentHandler<T extends ConfigArgs = ConfigArgs> extends Configurable
 
 
 </div>
-
-
-## FulfillmentHandlerConfig
-
 <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="48" packageName="@vendure/core" />
 
-The configuration object used to instantiate a <a href='/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler'>FulfillmentHandler</a>.
+The configuration object used to instantiate a <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-handler#fulfillmenthandler">FulfillmentHandler</DocsLink>.
 
 ```ts title="Signature"
 interface FulfillmentHandlerConfig<T extends ConfigArgs> extends ConfigurableOperationDefOptions<T> {
@@ -134,7 +126,7 @@ result will be returned.
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/state-machine/state-machine-config#ontransitionstartfn'>OnTransitionStartFn</a><<a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>, <a href='/reference/typescript-api/fulfillment/fulfillment-transition-data#fulfillmenttransitiondata'>FulfillmentTransitionData</a>>`}   />
 
 This allows the handler to intercept state transitions of the created Fulfillment. This works much in the
-same way as the <a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a> `onTransitionStart` method (i.e. returning `false` or
+same way as the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink> `onTransitionStart` method (i.e. returning `false` or
 `string` will be interpreted as an error and prevent the state transition), except that it is only invoked
 on Fulfillments which were created with this particular FulfillmentHandler.
 
@@ -143,10 +135,6 @@ shipping API.
 
 
 </div>
-
-
-## CreateFulfillmentFn
-
 <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="33" packageName="@vendure/core" />
 
 The function called when creating a new Fulfillment
@@ -159,10 +147,6 @@ type CreateFulfillmentFn<T extends ConfigArgs> = (
     args: ConfigArgValues<T>,
 ) => CreateFulfillmentResult | Promise<CreateFulfillmentResult>
 ```
-
-
-## CreateFulfillmentResult
-
 <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-handler.ts" sourceLine="23" packageName="@vendure/core" />
 
 

package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx

@@ -2,24 +2,16 @@
 title: "FulfillmentProcess"
 generated: true
 ---
-
-
-## defaultFulfillmentProcess
-
 <GenerationInfo sourceFile="packages/core/src/config/fulfillment/default-fulfillment-process.ts" sourceLine="45" packageName="@vendure/core" since="2.0.0" />
 
-The default <a href='/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess'>FulfillmentProcess</a>. This process includes the following actions:
+The default <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#fulfillmentprocess">FulfillmentProcess</DocsLink>. This process includes the following actions:
 
 - Executes the configured `FulfillmentHandler.onFulfillmentTransition()` before any state
   transition.
-- On cancellation of a Fulfillment, creates the necessary <a href='/reference/typescript-api/entities/stock-movement#cancellation'>Cancellation</a> & <a href='/reference/typescript-api/entities/stock-movement#allocation'>Allocation</a>
+- On cancellation of a Fulfillment, creates the necessary <DocsLink href="/reference/typescript-api/entities/stock-movement#cancellation">Cancellation</DocsLink> & <DocsLink href="/reference/typescript-api/entities/stock-movement#allocation">Allocation</DocsLink>
   stock movement records.
 - When a Fulfillment transitions from the `Created` to `Pending` state, the necessary
-  <a href='/reference/typescript-api/entities/stock-movement#sale'>Sale</a> stock movements are created.
-
-
-
-## FulfillmentProcess
+  <DocsLink href="/reference/typescript-api/entities/stock-movement#sale">Sale</DocsLink> stock movements are created.
 
 <GenerationInfo sourceFile="packages/core/src/config/fulfillment/fulfillment-process.ts" sourceLine="26" packageName="@vendure/core" since="2.0.0" />
 
@@ -28,7 +20,7 @@ in, and how it may transition from one state to another. Using the `onTransition
 FulfillmentProcess can perform checks before allowing a state transition to occur, and the `onTransitionEnd()`
 hook allows logic to be executed after a state change.
 
-For detailed description of the interface members, see the <a href='/reference/typescript-api/state-machine/state-machine-config#statemachineconfig'>StateMachineConfig</a> docs.
+For detailed description of the interface members, see the <DocsLink href="/reference/typescript-api/state-machine/state-machine-config#statemachineconfig">StateMachineConfig</DocsLink> docs.
 
 ```ts title="Signature"
 interface FulfillmentProcess<State extends keyof CustomFulfillmentStates | string> extends InjectableStrategy {

package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx

@@ -2,14 +2,10 @@
 title: "FulfillmentState"
 generated: true
 ---
-
-
-## FulfillmentState
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="29" packageName="@vendure/core" />
 
 These are the default states of the fulfillment process. By default, they will be extended
-by the <a href='/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess'>defaultFulfillmentProcess</a> to also include `Shipped` and `Delivered`.
+by the <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-process#defaultfulfillmentprocess">defaultFulfillmentProcess</DocsLink> to also include `Shipped` and `Delivered`.
 
 ```ts title="Signature"
 type FulfillmentState = | 'Created'

package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx

@@ -2,13 +2,9 @@
 title: "FulfillmentStates"
 generated: true
 ---
-
-
-## FulfillmentStates
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="19" packageName="@vendure/core" />
 
-An interface to extend standard <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>.
+An interface to extend standard <DocsLink href="/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate">FulfillmentState</DocsLink>.
 
 ```ts title="Signature"
 interface FulfillmentStates {

package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx

@@ -2,10 +2,6 @@
 title: "FulfillmentTransitionData"
 generated: true
 ---
-
-
-## FulfillmentTransitionData
-
 <GenerationInfo sourceFile="packages/core/src/service/helpers/fulfillment-state-machine/fulfillment-state.ts" sourceLine="42" packageName="@vendure/core" />
 
 The data which is passed to the state transition handler of the FulfillmentStateMachine.

package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx

@@ -2,10 +2,6 @@
 title: "HealthCheckRegistryService"
 generated: true
 ---
-
-
-## HealthCheckRegistryService
-
 <GenerationInfo sourceFile="packages/core/src/health-check/health-check-registry.service.ts" sourceLine="47" packageName="@vendure/core" />
 
 This service is used to register health indicator functions to be included in the
@@ -21,12 +17,12 @@ Plugins which rely on external services (web services, databases etc.) can make
 service to add a check for that dependency to the Vendure health check.
 
 
-Since v1.6.0, the preferred way to implement a custom health check is by creating a new <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a>
+Since v1.6.0, the preferred way to implement a custom health check is by creating a new <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink>
 and then passing it to the `systemOptions.healthChecks` array.
-See the <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> docs for an example configuration.
+See the <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> docs for an example configuration.
 
 The alternative way to register a health check is by injecting this service directly into your
-plugin module. To use it in your plugin, you'll need to import the <a href='/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule'>PluginCommonModule</a>:
+plugin module. To use it in your plugin, you'll need to import the <DocsLink href="/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule">PluginCommonModule</DocsLink>:
 
 *Example*
 

package/docs/reference/typescript-api/health-check/health-check-strategy.mdx

@@ -2,10 +2,6 @@
 title: "HealthCheckStrategy"
 generated: true
 ---
-
-
-## HealthCheckStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/system/health-check-strategy.ts" sourceLine="48" packageName="@vendure/core" />
 
 This strategy defines health checks which are included as part of the
@@ -19,7 +15,7 @@ Custom strategies should be added to the `systemOptions.healthChecks` array.
 By default, Vendure includes the `TypeORMHealthCheckStrategy`, so if you set the value of the `healthChecks`
 array, be sure to include it manually.
 
-Vendure also ships with the <a href='/reference/typescript-api/health-check/http-health-check-strategy#httphealthcheckstrategy'>HttpHealthCheckStrategy</a>, which is convenient
+Vendure also ships with the <DocsLink href="/reference/typescript-api/health-check/http-health-check-strategy#httphealthcheckstrategy">HttpHealthCheckStrategy</DocsLink>, which is convenient
 for adding a health check dependent on an HTTP ping.
 
 :::info

package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx

@@ -2,13 +2,9 @@
 title: "HttpHealthCheckStrategy"
 generated: true
 ---
-
-
-## HttpHealthCheckStrategy
-
 <GenerationInfo sourceFile="packages/core/src/health-check/http-health-check-strategy.ts" sourceLine="37" packageName="@vendure/core" />
 
-A <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> used to check health by pinging a url. Internally it uses
+A <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> used to check health by pinging a url. Internally it uses
 the [NestJS HttpHealthIndicator](https://docs.nestjs.com/recipes/terminus#http-healthcheck).
 
 *Example*

package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx

@@ -2,13 +2,9 @@
 title: "TypeORMHealthCheckStrategy"
 generated: true
 ---
-
-
-## TypeORMHealthCheckStrategy
-
 <GenerationInfo sourceFile="packages/core/src/health-check/typeorm-health-check-strategy.ts" sourceLine="38" packageName="@vendure/core" />
 
-A <a href='/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy'>HealthCheckStrategy</a> used to check the health of the database. This health
+A <DocsLink href="/reference/typescript-api/health-check/health-check-strategy#healthcheckstrategy">HealthCheckStrategy</DocsLink> used to check the health of the database. This health
 check is included by default, but can be customized by explicitly adding it to the
 `systemOptions.healthChecks` array:
 

package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx

@@ -2,16 +2,12 @@
 title: "AssetImportStrategy"
 generated: true
 ---
-
-
-## AssetImportStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/asset-import-strategy/asset-import-strategy.ts" sourceLine="25" packageName="@vendure/core" since="1.7.0" />
 
 The AssetImportStrategy determines how asset files get imported based on the path given in the
-import CSV or via the <a href='/reference/typescript-api/import-export/asset-importer#assetimporter'>AssetImporter</a> `getAssets()` method.
+import CSV or via the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> `getAssets()` method.
 
-The <a href='/reference/typescript-api/import-export/default-asset-import-strategy#defaultassetimportstrategy'>DefaultAssetImportStrategy</a> is able to load files from either the local filesystem
+The <DocsLink href="/reference/typescript-api/import-export/default-asset-import-strategy#defaultassetimportstrategy">DefaultAssetImportStrategy</DocsLink> is able to load files from either the local filesystem
 or from a remote URL.
 
 A custom strategy could be created which could e.g. get the asset file from an S3 bucket.

package/docs/reference/typescript-api/import-export/asset-importer.mdx

@@ -2,15 +2,11 @@
 title: "AssetImporter"
 generated: true
 ---
-
-
-## AssetImporter
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/asset-importer/asset-importer.ts" sourceLine="17" packageName="@vendure/core" />
 
-This service creates new <a href='/reference/typescript-api/entities/asset#asset'>Asset</a> entities based on string paths provided in the CSV
+This service creates new <DocsLink href="/reference/typescript-api/entities/asset#asset">Asset</DocsLink> entities based on string paths provided in the CSV
 import format. The source files are resolved by joining the value of `importExportOptions.importAssetsDir`
-with the asset path. This service is used internally by the <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a> service.
+with the asset path. This service is used internally by the <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink> service.
 
 ```ts title="Signature"
 class AssetImporter {

package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx

@@ -2,10 +2,6 @@
 title: "DefaultAssetImportStrategy"
 generated: true
 ---
-
-
-## DefaultAssetImportStrategy
-
 <GenerationInfo sourceFile="packages/core/src/config/asset-import-strategy/default-asset-import-strategy.ts" sourceLine="50" packageName="@vendure/core" since="1.7.0" />
 
 The DefaultAssetImportStrategy is able to import paths from the local filesystem (taking into account the

package/docs/reference/typescript-api/import-export/fast-importer-service.mdx

@@ -2,10 +2,6 @@
 title: "FastImporterService"
 generated: true
 ---
-
-
-## FastImporterService
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/importer/fast-importer.service.ts" sourceLine="41" packageName="@vendure/core" />
 
 A service to import entities into the database. This replaces the regular `create` methods of the service layer with faster

package/docs/reference/typescript-api/import-export/import-export-options.mdx

@@ -2,10 +2,6 @@
 title: "ImportExportOptions"
 generated: true
 ---
-
-
-## ImportExportOptions
-
 <GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="936" packageName="@vendure/core" />
 
 Options related to importing & exporting data.
@@ -29,7 +25,7 @@ The directory in which assets to be imported are located.
 <MemberInfo kind="property" type={`<a href='/reference/typescript-api/import-export/asset-import-strategy#assetimportstrategy'>AssetImportStrategy</a>`}  since="1.7.0"  />
 
 This strategy determines how asset files get imported based on the path given in the
-import CSV or via the <a href='/reference/typescript-api/import-export/asset-importer#assetimporter'>AssetImporter</a> `getAssets()` method.
+import CSV or via the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> `getAssets()` method.
 
 
 </div>

package/docs/reference/typescript-api/import-export/import-parser.mdx

@@ -2,14 +2,10 @@
 title: "ImportParser"
 generated: true
 ---
-
-
-## ImportParser
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="152" packageName="@vendure/core" />
 
 Validates and parses CSV files into a data structure which can then be used to created new entities.
-This is used internally by the <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a>.
+This is used internally by the <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink>.
 
 ```ts title="Signature"
 class ImportParser {
@@ -24,18 +20,14 @@ class ImportParser {
 <MemberInfo kind="method" type={`(input: string | Stream, mainLanguage: <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> = this.configService.defaultLanguageCode) => Promise<<a href='/reference/typescript-api/import-export/import-parser#parseresult'>ParseResult</a><<a href='/reference/typescript-api/import-export/import-parser#parsedproductwithvariants'>ParsedProductWithVariants</a>>>`}   />
 
 Parses the contents of the [product import CSV file](/guides/developer-guide/importing-data/#product-import-format) and
-returns a data structure which can then be used to populate Vendure using the <a href='/reference/typescript-api/import-export/fast-importer-service#fastimporterservice'>FastImporterService</a>.
+returns a data structure which can then be used to populate Vendure using the <DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink>.
 
 
 </div>
-
-
-## ParsedOptionGroup
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="45" packageName="@vendure/core" />
 
 The intermediate representation of an OptionGroup after it has been parsed
-by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
+by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
 
 ```ts title="Signature"
 interface ParsedOptionGroup {
@@ -57,14 +49,10 @@ interface ParsedOptionGroup {
 
 
 </div>
-
-
-## ParsedFacet
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="61" packageName="@vendure/core" />
 
 The intermediate representation of a Facet after it has been parsed
-by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
+by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
 
 ```ts title="Signature"
 interface ParsedFacet {
@@ -86,14 +74,10 @@ interface ParsedFacet {
 
 
 </div>
-
-
-## ParsedProductVariant
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="77" packageName="@vendure/core" />
 
 The intermediate representation of a ProductVariant after it has been parsed
-by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
+by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
 
 ```ts title="Signature"
 interface ParsedProductVariant {
@@ -159,14 +143,10 @@ interface ParsedProductVariant {
 
 
 </div>
-
-
-## ParsedProduct
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="102" packageName="@vendure/core" />
 
 The intermediate representation of a Product after it has been parsed
-by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a>.
+by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink>.
 
 ```ts title="Signature"
 interface ParsedProduct {
@@ -210,14 +190,10 @@ interface ParsedProduct {
 
 
 </div>
-
-
-## ParsedProductWithVariants
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="125" packageName="@vendure/core" />
 
 The data structure into which an import CSV file is parsed by the
-<a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a> `parseProducts()` method.
+<DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> `parseProducts()` method.
 
 ```ts title="Signature"
 interface ParsedProductWithVariants {
@@ -241,13 +217,9 @@ interface ParsedProductWithVariants {
 
 
 </div>
-
-
-## ParseResult
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/import-parser/import-parser.ts" sourceLine="137" packageName="@vendure/core" />
 
-The result returned by the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a> `parseProducts()` method.
+The result returned by the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> `parseProducts()` method.
 
 ```ts title="Signature"
 interface ParseResult<T> {

package/docs/reference/typescript-api/import-export/importer.mdx

@@ -2,16 +2,12 @@
 title: "Importer"
 generated: true
 ---
-
-
-## Importer
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/importer/importer.ts" sourceLine="42" packageName="@vendure/core" />
 
 Parses and imports Products using the CSV import format.
 
-Internally it is using the <a href='/reference/typescript-api/import-export/import-parser#importparser'>ImportParser</a> to parse the CSV file, and then the
-<a href='/reference/typescript-api/import-export/fast-importer-service#fastimporterservice'>FastImporterService</a> and the <a href='/reference/typescript-api/import-export/asset-importer#assetimporter'>AssetImporter</a> to actually create the resulting
+Internally it is using the <DocsLink href="/reference/typescript-api/import-export/import-parser#importparser">ImportParser</DocsLink> to parse the CSV file, and then the
+<DocsLink href="/reference/typescript-api/import-export/fast-importer-service#fastimporterservice">FastImporterService</DocsLink> and the <DocsLink href="/reference/typescript-api/import-export/asset-importer#assetimporter">AssetImporter</DocsLink> to actually create the resulting
 entities in the Vendure database.
 
 ```ts title="Signature"

package/docs/reference/typescript-api/import-export/initial-data.mdx

@@ -2,10 +2,6 @@
 title: "InitialData"
 generated: true
 ---
-
-
-## InitialData
-
 <GenerationInfo sourceFile="packages/core/src/data-import/types.ts" sourceLine="47" packageName="@vendure/core" />
 
 An object defining initial settings for a new Vendure installation.

package/docs/reference/typescript-api/import-export/populate.mdx

@@ -2,10 +2,6 @@
 title: "Populate"
 generated: true
 ---
-
-
-## populate
-
 <GenerationInfo sourceFile="packages/core/src/cli/populate.ts" sourceLine="51" packageName="@vendure/core" />
 
 Populates the Vendure server with some initial data and (optionally) product data from
@@ -18,9 +14,9 @@ The argument can be either a Channel object or a valid channel `token`.
 
 Internally the `populate()` function does the following:
 
-1. Uses the <a href='/reference/typescript-api/import-export/populator#populator'>Populator</a> to populate the <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>.
-2. If `productsCsvPath` is provided, uses <a href='/reference/typescript-api/import-export/importer#importer'>Importer</a> to populate Product data.
-3. Uses <a href='/reference/typescript-api/import-export/populator#populator'>Populator</a> to populate collections specified in the <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>.
+1. Uses the <DocsLink href="/reference/typescript-api/import-export/populator#populator">Populator</DocsLink> to populate the <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>.
+2. If `productsCsvPath` is provided, uses <DocsLink href="/reference/typescript-api/import-export/importer#importer">Importer</DocsLink> to populate Product data.
+3. Uses <DocsLink href="/reference/typescript-api/import-export/populator#populator">Populator</DocsLink> to populate collections specified in the <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>.
 
 *Example*
 

package/docs/reference/typescript-api/import-export/populator.mdx

@@ -2,13 +2,9 @@
 title: "Populator"
 generated: true
 ---
-
-
-## Populator
-
 <GenerationInfo sourceFile="packages/core/src/data-import/providers/populator/populator.ts" sourceLine="46" packageName="@vendure/core" />
 
-Responsible for populating the database with <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, i.e. non-product data such as countries, tax rates,
+Responsible for populating the database with <DocsLink href="/reference/typescript-api/import-export/initial-data#initialdata">InitialData</DocsLink>, i.e. non-product data such as countries, tax rates,
 shipping methods, payment methods & roles.
 
 ```ts title="Signature"
@@ -25,7 +21,7 @@ class Populator {
 <MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `}   />
 
 Should be run *before* populating the products, so that there are TaxRates by which
-product prices can be set. If the `channel` argument is set, then any <a href='/reference/typescript-api/entities/interfaces#channelaware'>ChannelAware</a>entities will be assigned to that Channel.
+product prices can be set. If the `channel` argument is set, then any <DocsLink href="/reference/typescript-api/entities/interfaces#channelaware">ChannelAware</DocsLink>entities will be assigned to that Channel.
 ### populateCollections
 
 <MemberInfo kind="method" type={`(data: <a href='/reference/typescript-api/import-export/initial-data#initialdata'>InitialData</a>, channel?: <a href='/reference/typescript-api/entities/channel#channel'>Channel</a>) => `}   />

package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx

@@ -2,13 +2,9 @@
 title: "DefaultJobQueuePlugin"
 generated: true
 ---
-
-
-## DefaultJobQueuePlugin
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/default-job-queue-plugin.ts" sourceLine="127" packageName="@vendure/core" />
 
-A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a>. If you add this
+A plugin which configures Vendure to use the SQL database to persist the JobQueue jobs using the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink>. If you add this
 plugin to an existing Vendure installation, you'll need to run a [database migration](/guides/developer-guide/migrations), since this
 plugin will add a new "job_record" table to the database.
 
@@ -27,7 +23,7 @@ export const config: VendureConfig = {
 
 ## Configuration
 
-It is possible to configure the behaviour of the <a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a> by passing options to the static `init()` function:
+It is possible to configure the behaviour of the <DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink> by passing options to the static `init()` function:
 
 ### pollInterval
 The interval in ms between polling for new jobs. The default is 200ms.
@@ -135,23 +131,15 @@ class DefaultJobQueuePlugin {
 
 
 </div>
-
-
-## cleanJobsTask
-
 <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/clean-jobs-task.ts" sourceLine="18" packageName="@vendure/core" since="3.3.0" />
 
-A <a href='/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask'>ScheduledTask</a> that cleans up old jobs from the database when using the DefaultJobQueuePlugin.
-You can configure the settings & schedule of the task via the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a> options.
-
-
-
-## DefaultJobQueueOptions
+A <DocsLink href="/reference/typescript-api/scheduled-tasks/scheduled-task#scheduledtask">ScheduledTask</DocsLink> that cleans up old jobs from the database when using the DefaultJobQueuePlugin.
+You can configure the settings & schedule of the task via the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink> options.
 
 <GenerationInfo sourceFile="packages/core/src/plugin/default-job-queue-plugin/types.ts" sourceLine="12" packageName="@vendure/core" />
 
 Configuration options for the DefaultJobQueuePlugin. These values get passed into the
-<a href='/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy'>SqlJobQueueStrategy</a>.
+<DocsLink href="/reference/typescript-api/job-queue/sql-job-queue-strategy#sqljobqueuestrategy">SqlJobQueueStrategy</DocsLink>.
 
 ```ts title="Signature"
 interface DefaultJobQueueOptions {

package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx

@@ -2,18 +2,14 @@
 title: "InMemoryJobBufferStorageStrategy"
 generated: true
 ---
-
-
-## InMemoryJobBufferStorageStrategy
-
 <GenerationInfo sourceFile="packages/core/src/job-queue/job-buffer/in-memory-job-buffer-storage-strategy.ts" sourceLine="17" packageName="@vendure/core" since="1.3.0" />
 
-A <a href='/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy'>JobBufferStorageStrategy</a> which keeps the buffered jobs in memory. Should
+A <DocsLink href="/reference/typescript-api/job-queue/job-buffer-storage-strategy#jobbufferstoragestrategy">JobBufferStorageStrategy</DocsLink> which keeps the buffered jobs in memory. Should
 _not_ be used in production, since it will lose data in the event of the server
 stopping.
 
-Instead, use the <a href='/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin'>DefaultJobQueuePlugin</a> with the `useDatabaseForBuffer: true` option set,
-or the <a href='/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin'>BullMQJobQueuePlugin</a> or another custom strategy with persistent storage.
+Instead, use the <DocsLink href="/reference/typescript-api/job-queue/default-job-queue-plugin#defaultjobqueueplugin">DefaultJobQueuePlugin</DocsLink> with the `useDatabaseForBuffer: true` option set,
+or the <DocsLink href="/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin">BullMQJobQueuePlugin</DocsLink> or another custom strategy with persistent storage.
 
 ```ts title="Signature"
 class InMemoryJobBufferStorageStrategy implements JobBufferStorageStrategy {