@vendure/docs 0.0.0-202601201808 → 0.0.0-202601211028

package/docs/reference/dashboard/extensions-api/form-components.mdx

@@ -2,10 +2,6 @@
 title: "FormComponents"
 generated: true
 ---
-
-
-## DashboardCustomFormComponent
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/form-components.ts" sourceLine="11" packageName="@vendure/dashboard" since="3.4.0" />
 
 Allows you to define custom form components for custom fields in the dashboard.
@@ -33,10 +29,6 @@ The React component that will be rendered as the custom form input.
 
 
 </div>
-
-
-## DashboardCustomFormComponents
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/form-components.ts" sourceLine="34" packageName="@vendure/dashboard" since="3.4.0" />
 
 Interface for registering custom field components in the dashboard.
@@ -59,10 +51,6 @@ custom fields in forms.
 
 
 </div>
-
-
-## DashboardFormComponentProps
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/form-engine-types.ts" sourceLine="92" packageName="@vendure/dashboard" since="3.4.0" />
 
 Props that get passed to all form input components. They are based on the
@@ -102,13 +90,9 @@ type DashboardFormComponentProps<TFieldValues extends FieldValues = FieldValues,
     fieldDef?: ConfigurableFieldDef;
 }
 ```
-
-
-## DashboardFormComponentMetadata
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/form-engine-types.ts" sourceLine="124" packageName="@vendure/dashboard" since="3.4.0" />
 
-Metadata which can be defined on a <a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponent'>DashboardFormComponent</a> which
+Metadata which can be defined on a <DocsLink href="/reference/dashboard/extensions-api/form-components#dashboardformcomponent">DashboardFormComponent</DocsLink> which
 provides additional information about how the dashboard should render the
 component.
 
@@ -152,10 +136,6 @@ TODO: not currently implemented
 
 
 </div>
-
-
-## DashboardFormComponent
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/form-engine/form-engine-types.ts" sourceLine="167" packageName="@vendure/dashboard" since="3.4.0" />
 
 This is the common type for all custom form components registered for:

package/docs/reference/dashboard/extensions-api/history-entries.mdx

@@ -2,10 +2,6 @@
 title: "HistoryEntries"
 generated: true
 ---
-
-
-## DashboardHistoryEntryComponent
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/history-entries.ts" sourceLine="96" packageName="@vendure/dashboard" since="3.4.3" />
 
 A definition of a custom component that will be used to render the given
@@ -58,14 +54,14 @@ The `type` should correspond to a valid `HistoryEntryType`, such as
 
 - `CUSTOMER_REGISTERED`
 - `ORDER_STATE_TRANSITION`
-- some custom type - see the <a href='/reference/typescript-api/services/history-service#historyservice'>HistoryService</a> docs for a guide on
+- some custom type - see the <DocsLink href="/reference/typescript-api/services/history-service#historyservice">HistoryService</DocsLink> docs for a guide on
   how to define custom history entry types.
 ### component
 
-<MemberInfo kind="property" type={`React.ComponentType&#60;{         entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>;         entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail;     }&#62;`}   />
+<MemberInfo kind="property" type={`React.ComponentType<{         entry: <a href='/reference/dashboard/extensions-api/history-entries#historyentryitem'>HistoryEntryItem</a>;         entity: OrderHistoryOrderDetail | CustomerHistoryCustomerDetail;     }>`}   />
 
 The component which is used to render the timeline entry. It should use the
-<a href='/reference/dashboard/extensions-api/history-entries#historyentry'>HistoryEntry</a> component and pass the appropriate props to configure
+<DocsLink href="/reference/dashboard/extensions-api/history-entries#historyentry">HistoryEntry</DocsLink> component and pass the appropriate props to configure
 how it will be displayed.
 
 The `entity` prop will be a subset of the Order object for Order history entries,
@@ -73,10 +69,6 @@ or a subset of the Customer object for customer history entries.
 
 
 </div>
-
-
-## HistoryEntryItem
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/history-entries.ts" sourceLine="14" packageName="@vendure/dashboard" since="3.4.3" />
 
 This object contains the information about the history entry.
@@ -148,13 +140,9 @@ and the `ORDER_STATE_TRANSITION` data looks like this:
 
 
 </div>
-
-
-## HistoryEntryProps
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/history-entry/history-entry.tsx" sourceLine="14" packageName="@vendure/dashboard" since="3.4.3" />
 
-The props for the <a href='/reference/dashboard/extensions-api/history-entries#historyentry'>HistoryEntry</a> component.
+The props for the <DocsLink href="/reference/dashboard/extensions-api/history-entries#historyentry">HistoryEntry</DocsLink> component.
 
 ```ts title="Signature"
 interface HistoryEntryProps {
@@ -226,10 +214,6 @@ be collapsible.
 
 
 </div>
-
-
-## HistoryEntry
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/history-entry/history-entry.tsx" sourceLine="74" packageName="@vendure/dashboard" since="3.4.3" />
 
 A component which is used to display a history entry in the order/customer history timeline.
@@ -241,5 +225,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/history-entries#historyentryprops'>HistoryEntryProps</a>>`} />
 

package/docs/reference/dashboard/extensions-api/login.mdx

@@ -2,10 +2,6 @@
 title: "Login"
 generated: true
 ---
-
-
-## DashboardLoginExtensions
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="60" packageName="@vendure/dashboard" since="3.4.0" />
 
 Defines all available login page extensions.
@@ -38,10 +34,6 @@ Component to render after the login form.
 
 
 </div>
-
-
-## LoginLogoExtension
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="11" packageName="@vendure/dashboard" since="3.4.0" />
 
 Defines a custom logo component for the login page.
@@ -62,10 +54,6 @@ A React component that will replace the default Vendure logo.
 
 
 </div>
-
-
-## LoginBeforeFormExtension
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="27" packageName="@vendure/dashboard" since="3.4.0" />
 
 Defines content to display before the login form.
@@ -86,10 +74,6 @@ A React component that will be rendered before the login form.
 
 
 </div>
-
-
-## LoginAfterFormExtension
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="43" packageName="@vendure/dashboard" since="3.4.0" />
 
 Defines content to display after the login form.

package/docs/reference/dashboard/extensions-api/navigation.mdx

@@ -2,10 +2,6 @@
 title: "Navigation"
 generated: true
 ---
-
-
-## DashboardNavSectionDefinition
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/navigation.ts" sourceLine="73" packageName="@vendure/dashboard" since="3.4.0" />
 
 Defines a custom navigation section in the dashboard sidebar.
@@ -60,10 +56,6 @@ Optional placement to control the position of this section in the sidebar.
 
 
 </div>
-
-
-## NavMenuItem
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/nav-menu/nav-menu-extensions.ts" sourceLine="16" packageName="@vendure/dashboard" since="3.4.0" />
 
 Defines an items in the navigation menu.

package/docs/reference/dashboard/extensions-api/page-blocks.mdx

@@ -2,10 +2,6 @@
 title: "Page Blocks"
 generated: true
 ---
-
-
-## DashboardPageBlockDefinition
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/layout.ts" sourceLine="95" packageName="@vendure/dashboard" since="3.3.0" />
 
 This allows you to insert a custom component into a specific location
@@ -43,12 +39,12 @@ The location of the page block. It specifies the pageId, and then the
 relative location compared to another existing block.
 ### component
 
-<MemberInfo kind="property" type={`React.FunctionComponent&#60;{ context: PageContextValue }&#62;`}   />
+<MemberInfo kind="property" type={`React.FunctionComponent<{ context: PageContextValue }>`}   />
 
 The component to be rendered inside the page block.
 ### shouldRender
 
-<MemberInfo kind="property" type={`(context: PageContextValue) =&#62; boolean`}  since="3.5.0"  />
+<MemberInfo kind="property" type={`(context: PageContextValue) => boolean`}  since="3.5.0"  />
 
 Control whether to render the page block depending on your custom
 logic.
@@ -70,10 +66,6 @@ For more advanced control over rendering, use the `shouldRender` function.
 
 
 </div>
-
-
-## PageBlockPosition
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/layout.ts" sourceLine="67" packageName="@vendure/dashboard" since="3.3.0" />
 
 The relative position of a PageBlock. This is determined by finding an existing
@@ -102,10 +94,6 @@ type PageBlockPosition = {
 
 
 </div>
-
-
-## PageBlockLocation
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/layout.ts" sourceLine="79" packageName="@vendure/dashboard" since="3.3.0" />
 
 The location of a page block in the dashboard. The location can be found by turning on

package/docs/reference/dashboard/extensions-api/routes.mdx

@@ -2,10 +2,6 @@
 title: "Routes"
 generated: true
 ---
-
-
-## DashboardRouteDefinition
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/navigation.ts" sourceLine="15" packageName="@vendure/dashboard" since="3.4.0" />
 
 Defines a custom route for the dashboard with optional navigation menu integration.
@@ -25,7 +21,7 @@ interface DashboardRouteDefinition {
 
 ### component
 
-<MemberInfo kind="property" type={`(route: AnyRoute) =&#62; React.ReactNode`}   />
+<MemberInfo kind="property" type={`(route: AnyRoute) => React.ReactNode`}   />
 
 The React component that will be rendered for this route.
 ### path
@@ -35,7 +31,7 @@ The React component that will be rendered for this route.
 The URL path for this route, e.g. '/my-custom-page'.
 ### navMenuItem
 
-<MemberInfo kind="property" type={`Partial&#60;<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>&#62; &#38; { sectionId: string }`}   />
+<MemberInfo kind="property" type={`Partial<<a href='/reference/dashboard/extensions-api/navigation#navmenuitem'>NavMenuItem</a>> &#38; { sectionId: string }`}   />
 
 Optional navigation menu item configuration to add this route to the nav menu
 on the left side of the dashboard.
@@ -45,14 +41,14 @@ this item should appear in. It can also point to custom nav menu sections that
 have been defined using the `navSections` extension property.
 ### loader
 
-<MemberInfo kind="property" type={`RouteOptions&#60;any&#62;['loader']`}   />
+<MemberInfo kind="property" type={`RouteOptions<any>['loader']`}   />
 
 Optional loader function to fetch data before the route renders.
 The value is a Tanstack Router
 [loader function](https://tanstack.com/router/latest/docs/framework/react/guide/data-loading#route-loaders)
 ### validateSearch
 
-<MemberInfo kind="property" type={`RouteOptions&#60;any&#62;['validateSearch']`}   />
+<MemberInfo kind="property" type={`RouteOptions<any>['validateSearch']`}   />
 
 Optional search parameter validation function.
 The value is a Tanstack Router

package/docs/reference/dashboard/extensions-api/widgets.mdx

@@ -2,10 +2,6 @@
 title: "Widgets"
 generated: true
 ---
-
-
-## DashboardWidgetDefinition
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/widgets.ts" sourceLine="70" packageName="@vendure/dashboard" since="3.3.0" />
 
 **Status: Developer Preview**
@@ -37,7 +33,7 @@ A unique identifier for the widget.
 The display name of the widget.
 ### component
 
-<MemberInfo kind="property" type={`React.ComponentType&#60;<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>&#62;`}   />
+<MemberInfo kind="property" type={`React.ComponentType<<a href='/reference/dashboard/extensions-api/widgets#dashboardbasewidgetprops'>DashboardBaseWidgetProps</a>>`}   />
 
 The React component that renders the widget.
 ### defaultSize

package/docs/reference/dashboard/form-components/affixed-input.mdx

@@ -2,10 +2,6 @@
 title: "AffixedInput"
 generated: true
 ---
-
-
-## AffixedInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/affixed-input.tsx" sourceLine="31" packageName="@vendure/dashboard" />
 
 A component for displaying an input with a prefix and/or a suffix.
@@ -29,5 +25,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;AffixedInputProps&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<AffixedInputProps>`} />
 

package/docs/reference/dashboard/form-components/boolean-input.mdx

@@ -2,10 +2,6 @@
 title: "BooleanInput"
 generated: true
 ---
-
-
-## BooleanInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/boolean-input.tsx" sourceLine="12" packageName="@vendure/dashboard" />
 
 Displays a boolean value as a switch toggle.
@@ -17,5 +13,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
 

package/docs/reference/dashboard/form-components/checkbox-input.mdx

@@ -2,10 +2,6 @@
 title: "CheckboxInput"
 generated: true
 ---
-
-
-## CheckboxInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/checkbox-input.tsx" sourceLine="12" packageName="@vendure/dashboard" />
 
 Displays a boolean value as a checkbox.
@@ -17,5 +13,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
 

package/docs/reference/dashboard/form-components/date-time-input.mdx

@@ -2,10 +2,6 @@
 title: "DateTimeInput"
 generated: true
 ---
-
-
-## DateTimeInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/datetime-input.tsx" sourceLine="41" packageName="@vendure/dashboard" />
 
 A component for selecting a date and time.
@@ -17,5 +13,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
 

package/docs/reference/dashboard/form-components/form-field-wrapper.mdx

@@ -2,10 +2,6 @@
 title: "FormFieldWrapper"
 generated: true
 ---
-
-
-## FormFieldWrapper
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/form-field-wrapper.tsx" sourceLine="74" packageName="@vendure/dashboard" since="3.4.0" />
 
 This is a wrapper that can be used in all forms to wrap the actual form control, and provide a label, description and error message.
@@ -34,7 +30,7 @@ overridden form components.
 </PageBlock>
 ```
 
-If you are dealing with translatable fields, use the <a href='/reference/dashboard/form-components/translatable-form-field-wrapper#translatableformfieldwrapper'>TranslatableFormFieldWrapper</a> component instead.
+If you are dealing with translatable fields, use the <DocsLink href="/reference/dashboard/form-components/translatable-form-field-wrapper#translatableformfieldwrapper">TranslatableFormFieldWrapper</DocsLink> component instead.
 
 ```ts title="Signature"
 function FormFieldWrapper<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: FormFieldWrapperProps<TFieldValues, TName>): void
@@ -43,11 +39,7 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a>&#60;TFieldValues, TName&#62;`} />
-
-
-
-## FormFieldWrapperProps
+<MemberInfo kind="parameter" type={`<a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapperprops'>FormFieldWrapperProps</a><TFieldValues, TName>`} />
 
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/form-field-wrapper.tsx" sourceLine="14" packageName="@vendure/dashboard" since="3.4.0" />
 

package/docs/reference/dashboard/form-components/money-input.mdx

@@ -2,10 +2,6 @@
 title: "MoneyInput"
 generated: true
 ---
-
-
-## MoneyInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/money-input.tsx" sourceLine="22" packageName="@vendure/dashboard" />
 
 A component for displaying a money value. The `currency` can be specified, but otherwise
@@ -18,5 +14,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;MoneyInputProps&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<MoneyInputProps>`} />
 

package/docs/reference/dashboard/form-components/number-input.mdx

@@ -2,10 +2,6 @@
 title: "NumberInput"
 generated: true
 ---
-
-
-## NumberInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/number-input.tsx" sourceLine="23" packageName="@vendure/dashboard" />
 
 A component for displaying a numeric value.
@@ -17,5 +13,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;NumberInputProps&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<NumberInputProps>`} />
 

package/docs/reference/dashboard/form-components/password-input.mdx

@@ -2,10 +2,6 @@
 title: "PasswordInput"
 generated: true
 ---
-
-
-## PasswordFormInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/password-form-input.tsx" sourceLine="12" packageName="@vendure/dashboard" />
 
 A component for displaying a password input.
@@ -17,5 +13,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
 

package/docs/reference/dashboard/form-components/rich-text-input.mdx

@@ -2,10 +2,6 @@
 title: "RichTextInput"
 generated: true
 ---
-
-
-## RichTextInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/rich-text-input.tsx" sourceLine="12" packageName="@vendure/dashboard" />
 
 A component for displaying a rich text editor. Internally uses ProseMirror (rich text editor) under the hood.
@@ -17,5 +13,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
 

package/docs/reference/dashboard/form-components/slug-input.mdx

@@ -2,10 +2,6 @@
 title: "SlugInput"
 generated: true
 ---
-
-
-## SlugInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/slug-input.tsx" sourceLine="137" packageName="@vendure/dashboard" />
 
 A component for generating and displaying slugs based on a watched field.

package/docs/reference/dashboard/form-components/text-input.mdx

@@ -2,10 +2,6 @@
 title: "TextInput"
 generated: true
 ---
-
-
-## TextInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/text-input.tsx" sourceLine="13" packageName="@vendure/dashboard" />
 
 A component for displaying a text input.

package/docs/reference/dashboard/form-components/textarea-input.mdx

@@ -2,10 +2,6 @@
 title: "TextareaInput"
 generated: true
 ---
-
-
-## TextareaInput
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/data-input/textarea-input.tsx" sourceLine="12" packageName="@vendure/dashboard" />
 
 A component for displaying a textarea input.
@@ -17,5 +13,5 @@ Parameters
 
 ### props
 
-<MemberInfo kind="parameter" type={`Readonly&#60;<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>&#62;`} />
+<MemberInfo kind="parameter" type={`Readonly<<a href='/reference/dashboard/extensions-api/form-components#dashboardformcomponentprops'>DashboardFormComponentProps</a>>`} />
 

package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx

@@ -2,13 +2,9 @@
 title: "TranslatableFormFieldWrapper"
 generated: true
 ---
-
-
-## TranslatableFormFieldWrapper
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/translatable-form-field.tsx" sourceLine="112" packageName="@vendure/dashboard" since="3.4.0" />
 
-This is the equivalent of the <a href='/reference/dashboard/form-components/form-field-wrapper#formfieldwrapper'>FormFieldWrapper</a> component, but for translatable fields.
+This is the equivalent of the <DocsLink href="/reference/dashboard/form-components/form-field-wrapper#formfieldwrapper">FormFieldWrapper</DocsLink> component, but for translatable fields.
 
 *Example*
 
@@ -38,10 +34,6 @@ This is the equivalent of the <a href='/reference/dashboard/form-components/form
 </PageBlock>
 ```
 
-
-
-## TranslatableFormFieldProps
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/components/shared/translatable-form-field.tsx" sourceLine="22" packageName="@vendure/dashboard" since="3.4.0" />
 
 The props for the TranslatableFormField component.

package/docs/reference/dashboard/hooks/use-alerts.mdx

@@ -2,10 +2,6 @@
 title: "UseAlerts"
 generated: true
 ---
-
-
-## useAlerts
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/hooks/use-alerts.ts" sourceLine="31" packageName="@vendure/dashboard" since="3.5.0" />
 
 Returns information about all registered Alerts, including how many are
@@ -14,10 +10,6 @@ active and at what severity.
 ```ts title="Signature"
 function useAlerts(): { alerts: AlertEntry[]; activeCount: number; highestSeverity: AlertSeverity }
 ```
-
-
-## AlertEntry
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/hooks/use-alerts.ts" sourceLine="13" packageName="@vendure/dashboard" since="3.5.0" />
 
 An individual Alert item.
@@ -56,7 +48,7 @@ interface AlertEntry {
 
 ### dismiss
 
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />
 
 
 

package/docs/reference/dashboard/hooks/use-auth.mdx

@@ -2,22 +2,14 @@
 title: "UseAuth"
 generated: true
 ---
-
-
-## useAuth
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/hooks/use-auth.tsx" sourceLine="15" packageName="@vendure/dashboard" since="3.3.0" />
 
-Provides access to the <a href='/reference/dashboard/hooks/use-auth#authcontext'>AuthContext</a> which contains information
+Provides access to the <DocsLink href="/reference/dashboard/hooks/use-auth#authcontext">AuthContext</DocsLink> which contains information
 about the active channel.
 
 ```ts title="Signature"
 function useAuth(): void
 ```
-
-
-## AuthContext
-
 <GenerationInfo sourceFile="packages/dashboard/src/lib/providers/auth.tsx" sourceLine="17" packageName="@vendure/dashboard" since="3.3.0" />
 
 Provides information about the current user & their authentication & authorization
@@ -55,27 +47,27 @@ The error message if the authentication fails.
 Whether the user is authenticated.
 ### login
 
-<MemberInfo kind="property" type={`(username: string, password: string, onSuccess?: () =&#62; void) =&#62; void`}   />
+<MemberInfo kind="property" type={`(username: string, password: string, onSuccess?: () => void) => void`}   />
 
 The function to login the user.
 ### logout
 
-<MemberInfo kind="property" type={`(onSuccess?: () =&#62; void) =&#62; Promise&#60;void&#62;`}   />
+<MemberInfo kind="property" type={`(onSuccess?: () => void) => Promise<void>`}   />
 
 The function to logout the user.
 ### user
 
-<MemberInfo kind="property" type={`ResultOf&#60;typeof CurrentUserQuery&#62;['activeAdministrator'] | undefined`}   />
+<MemberInfo kind="property" type={`ResultOf<typeof CurrentUserQuery>['activeAdministrator'] | undefined`}   />
 
 The user object.
 ### channels
 
-<MemberInfo kind="property" type={`NonNullable&#60;ResultOf&#60;typeof CurrentUserQuery&#62;['me']&#62;['channels'] | undefined`}   />
+<MemberInfo kind="property" type={`NonNullable<ResultOf<typeof CurrentUserQuery>['me']>['channels'] | undefined`}   />
 
 The channels object.
 ### refreshCurrentUser
 
-<MemberInfo kind="property" type={`() =&#62; void`}   />
+<MemberInfo kind="property" type={`() => void`}   />
 
 The function to refresh the current user.