@vendure/docs 0.0.0-202601271334 → 0.0.0-202601280949

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  // dates.generated.ts (auto-generated, do not edit)
2
- // Generated at: 2026-01-27T12:34:43.366Z
2
+ // Generated at: 2026-01-28T08:50:01.721Z
3
3
  // Total files: 805
4
4
  export const lastModifiedDates = {
5
5
  'docs/guides/core-concepts/auth/index.mdx': '2026-01-27T13:31:29+01:00',
@@ -78,7 +78,7 @@ export const lastModifiedDates = {
78
78
  'docs/guides/extending-the-admin-ui/custom-timeline-components/index.mdx': '2026-01-27T13:31:29+01:00',
79
79
  'docs/guides/extending-the-admin-ui/dashboard-widgets/index.mdx': '2026-01-27T13:31:29+01:00',
80
80
  'docs/guides/extending-the-admin-ui/defining-routes/index.mdx': '2026-01-27T13:31:29+01:00',
81
- 'docs/guides/extending-the-admin-ui/getting-started/index.mdx': '2026-01-27T13:31:29+01:00',
81
+ 'docs/guides/extending-the-admin-ui/getting-started/index.mdx': '2026-01-28T09:24:47+01:00',
82
82
  'docs/guides/extending-the-admin-ui/nav-menu/index.mdx': '2026-01-27T13:31:29+01:00',
83
83
  'docs/guides/extending-the-admin-ui/page-tabs/index.mdx': '2026-01-16T19:58:56+01:00',
84
84
  'docs/guides/extending-the-admin-ui/ui-library/index.mdx': '2026-01-16T19:58:56+01:00',
@@ -89,7 +89,7 @@ export const lastModifiedDates = {
89
89
  'docs/guides/extending-the-dashboard/creating-pages/list-pages.mdx': '2026-01-27T13:31:29+01:00',
90
90
  'docs/guides/extending-the-dashboard/creating-pages/tabbed-pages.mdx': '2026-01-27T13:31:29+01:00',
91
91
  'docs/guides/extending-the-dashboard/custom-form-components/form-component-examples.mdx': '2026-01-16T19:58:56+01:00',
92
- 'docs/guides/extending-the-dashboard/custom-form-components/index.mdx': '2026-01-27T13:31:29+01:00',
92
+ 'docs/guides/extending-the-dashboard/custom-form-components/index.mdx': '2026-01-28T09:24:47+01:00',
93
93
  'docs/guides/extending-the-dashboard/custom-form-components/relation-selectors.mdx': '2026-01-16T19:58:56+01:00',
94
94
  'docs/guides/extending-the-dashboard/customizing-pages/action-bar-items.mdx': '2026-01-27T13:31:29+01:00',
95
95
  'docs/guides/extending-the-dashboard/customizing-pages/customizing-detail-pages.mdx': '2026-01-27T13:31:29+01:00',
@@ -98,21 +98,21 @@ export const lastModifiedDates = {
98
98
  'docs/guides/extending-the-dashboard/customizing-pages/history-entries.mdx': '2026-01-16T19:58:56+01:00',
99
99
  'docs/guides/extending-the-dashboard/customizing-pages/index.mdx': '2026-01-27T13:31:29+01:00',
100
100
  'docs/guides/extending-the-dashboard/customizing-pages/insights-widgets.mdx': '2026-01-16T19:58:56+01:00',
101
- 'docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx': '2026-01-27T13:31:29+01:00',
101
+ 'docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx': '2026-01-28T09:24:47+01:00',
102
102
  'docs/guides/extending-the-dashboard/data-fetching/index.mdx': '2026-01-27T13:31:29+01:00',
103
- 'docs/guides/extending-the-dashboard/deployment/index.mdx': '2026-01-16T19:58:56+01:00',
103
+ 'docs/guides/extending-the-dashboard/deployment/index.mdx': '2026-01-28T09:24:47+01:00',
104
104
  'docs/guides/extending-the-dashboard/extending-overview/index.mdx': '2026-01-27T13:31:29+01:00',
105
- 'docs/guides/extending-the-dashboard/getting-started/index.mdx': '2026-01-16T19:58:56+01:00',
105
+ 'docs/guides/extending-the-dashboard/getting-started/index.mdx': '2026-01-28T09:24:47+01:00',
106
106
  'docs/guides/extending-the-dashboard/localization/index.mdx': '2026-01-16T17:06:22+01:00',
107
107
  'docs/guides/extending-the-dashboard/migration/index.mdx': '2026-01-27T13:31:29+01:00',
108
- 'docs/guides/extending-the-dashboard/navigation/index.mdx': '2026-01-27T13:31:29+01:00',
108
+ 'docs/guides/extending-the-dashboard/navigation/index.mdx': '2026-01-28T09:24:47+01:00',
109
109
  'docs/guides/extending-the-dashboard/tech-stack/index.mdx': '2026-01-16T19:58:56+01:00',
110
110
  'docs/guides/extending-the-dashboard/theming/index.mdx': '2026-01-16T19:58:56+01:00',
111
111
  'docs/guides/getting-started/graphql-intro/index.mdx': '2026-01-27T13:31:29+01:00',
112
112
  'docs/guides/getting-started/installation/index.mdx': '2026-01-27T13:31:29+01:00',
113
113
  'docs/guides/getting-started/try-the-api/index.mdx': '2026-01-27T13:31:29+01:00',
114
- 'docs/guides/how-to/cms-integration-plugin/index.mdx': '2026-01-27T13:31:29+01:00',
115
- 'docs/guides/how-to/codegen/index.mdx': '2026-01-27T13:31:29+01:00',
114
+ 'docs/guides/how-to/cms-integration-plugin/index.mdx': '2026-01-28T09:24:47+01:00',
115
+ 'docs/guides/how-to/codegen/index.mdx': '2026-01-28T09:24:47+01:00',
116
116
  'docs/guides/how-to/configurable-products/index.mdx': '2026-01-27T13:31:29+01:00',
117
117
  'docs/guides/how-to/digital-products/index.mdx': '2026-01-27T13:31:29+01:00',
118
118
  'docs/guides/how-to/github-oauth-authentication/index.mdx': '2026-01-27T13:31:29+01:00',
@@ -260,7 +260,7 @@ export const lastModifiedDates = {
260
260
  'docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx': '2026-01-21T10:28:03+01:00',
261
261
  'docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx': '2026-01-21T10:28:03+01:00',
262
262
  'docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx': '2026-01-21T10:28:03+01:00',
263
- 'docs/reference/core-plugins/admin-ui-plugin/index.mdx': '2026-01-27T13:31:29+01:00',
263
+ 'docs/reference/core-plugins/admin-ui-plugin/index.mdx': '2026-01-28T09:24:47+01:00',
264
264
  'docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx': '2026-01-21T10:28:03+01:00',
265
265
  'docs/reference/core-plugins/asset-server-plugin/cache-config.mdx': '2026-01-21T10:28:03+01:00',
266
266
  'docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx': '2026-01-21T14:47:34+01:00',
@@ -2,7 +2,7 @@
2
2
  title: 'Getting Started'
3
3
  ---
4
4
 
5
- :::warning Angular Admin UI Deprecation
5
+ :::warning[Angular Admin UI Deprecation]
6
6
  The Angular-based Admin UI has been replaced by the new [React Admin Dashboard](/extending-the-dashboard/getting-started/). The Angular Admin UI will not be maintained after **July 2026**.
7
7
  Until then, we will continue patching critical bugs and security issues. Community contributions will always be merged and released.
8
8
 
@@ -254,7 +254,7 @@ operation argument.
254
254
 
255
255
  You can access validation data for the current field or the whole form by using the `useFormContext` hook.
256
256
 
257
- :::note Error Messages
257
+ :::note[Error Messages]
258
258
  Your component does not need to handle standard error messages - the Dashboard will handle them for you.
259
259
 
260
260
  For example, if your custom field specifies a `pattern` property, the Dashboard will automatically display an error message
@@ -306,7 +306,7 @@ export const ValidatedInputComponent: DashboardFormComponent = ({ value, onChang
306
306
  }
307
307
  ```
308
308
 
309
- :::tip Best Practices
309
+ :::tip[Best Practices]
310
310
 
311
311
  1. **Always use Shadcn UI components** from the `@vendure/dashboard` package for consistent styling
312
312
  2. **Handle React Hook Form events properly** - call `onChange` and `onBlur` appropriately for custom field components
@@ -234,7 +234,7 @@ To find the `pageId` and `blockId` values for positioning your blocks:
234
234
  3. Hover over existing blocks to see their IDs
235
235
  4. Use these IDs in your block positioning configuration
236
236
 
237
- :::tip Best Practices
237
+ :::tip[Best Practices]
238
238
 
239
239
  1. **Use descriptive IDs**: Choose clear, unique IDs for your blocks
240
240
  2. **Position thoughtfully**: Consider the user experience when placing blocks
@@ -51,7 +51,7 @@ export default defineConfig({
51
51
 
52
52
  ### 2. Add DashboardPlugin to Vendure Config
53
53
 
54
- :::info Angular Admin UI compatibility
54
+ :::info[Angular Admin UI compatibility]
55
55
  If you want to use the Angular Admin UI and the Dashboard together, both plugins can now be used simultaneously without any special configuration.
56
56
  :::
57
57
 
@@ -151,7 +151,7 @@ export default defineConfig({
151
151
  });
152
152
  ```
153
153
 
154
- :::warning Build-Time Variables
154
+ :::warning[Build-Time Variables]
155
155
  Environment variables are resolved at **build time** and embedded as static strings in the final bundles. Ensure these variables are available during the build process, not just at runtime.
156
156
  :::
157
157
 
@@ -185,7 +185,7 @@ npx vite
185
185
 
186
186
  To stop the running dashboard, type `q` and hit enter.
187
187
 
188
- :::info Compatibility with the legacy Admin UI
188
+ :::info[Compatibility with the legacy Admin UI]
189
189
  If you still need to run the legacy Angular-based Admin UI in parallel with the Dashboard,
190
190
  this is totally possible. Both plugins can now be used simultaneously without any special configuration.
191
191
  :::
@@ -158,7 +158,7 @@ Order values are scoped within each placement area. This means:
158
158
 
159
159
  This means if you want to add a section between Catalog and Sales in the top area, you might use `order: 250`. If you want to add a section before Settings in the bottom area, you could use `order: 150`.
160
160
 
161
- :::note Default Placement
161
+ :::note[Default Placement]
162
162
  If you don't specify a `placement`, sections default to `'top'` placement.
163
163
  :::
164
164
 
@@ -311,7 +311,7 @@ Common icons for navigation sections:
311
311
 
312
312
  ## Best Practices
313
313
 
314
- :::tip Navigation Design Guidelines
314
+ :::tip[Navigation Design Guidelines]
315
315
 
316
316
  1. **Use descriptive section names**: Choose clear, concise names that indicate the section's purpose
317
317
  2. **Group related functionality**: Keep logically related menu items in the same section
@@ -395,7 +395,7 @@ async findCollectionsForVariant(
395
395
  }
396
396
  ```
397
397
 
398
- :::info Additional Entity Types
398
+ :::info[Additional Entity Types]
399
399
  The service can also includes `syncVariantToCms()` and `syncCollectionToCms()` methods that follow the same pattern as the product sync shown above.
400
400
 
401
401
  These implementations are omitted from this guide for brevity, but they handle their respective entity types with similar data fetching, relationship resolution, and error handling patterns.
@@ -410,7 +410,7 @@ This sync service provides the foundation for handling all Vendure-specific comp
410
410
  <Tabs>
411
411
  <TabItem value="storyblok" label="Storyblok">
412
412
 
413
- :::tip Working Example
413
+ :::tip[Working Example]
414
414
  The complete, production-ready Storyblok implementation can be found in the [Storyblok integration example](https://github.com/vendurehq/examples/tree/master/examples/storyblok-cms-integration). Refer to it for a minimal working implementation.
415
415
  :::
416
416
 
@@ -728,7 +728,7 @@ The complete implementations can be found in the working [example repositories](
728
728
  </TabItem>
729
729
  <TabItem value="contentful" label="Contentful">
730
730
 
731
- :::tip Working Example
731
+ :::tip[Working Example]
732
732
  The complete, production-ready Contentful implementation can be found in the [Contentful integration example](https://github.com/vendurehq/examples/tree/master/examples/contentful-cms-integration). It includes advanced features like locale mapping, bulk operations, and a robust setup process.
733
733
  :::
734
734
 
@@ -966,7 +966,7 @@ This same pattern is used to link variants to their parent product and to their
966
966
 
967
967
  These methods perform the core Create, Read, Update, and Delete logic. They rely on our centralized `makeContentfulRequest` method and handle the specifics of Contentful's API, such as versioning and the publish workflow.
968
968
 
969
- :::info Contentful's Publish Workflow
969
+ :::info[Contentful's Publish Workflow]
970
970
  Contentful requires entries to be explicitly published before they are visible in the Delivery API. After creating or updating an entry, we must make a separate API call to publish it. Similarly, to delete an entry, it must first be unpublished.
971
971
  :::
972
972
 
@@ -1052,7 +1052,7 @@ This configuration provides a complete Contentful CMS integration that automatic
1052
1052
 
1053
1053
  <TabItem value="strapi" label="Strapi">
1054
1054
 
1055
- :::tip Working Example
1055
+ :::tip[Working Example]
1056
1056
  The complete, production-ready Strapi implementation can be found in the [Strapi integration example](https://github.com/vendurehq/examples/tree/master/examples/strapi-cms-integration). It includes advanced features like plugin-based content types, batch operations, and relationship management.
1057
1057
  :::
1058
1058
 
@@ -1382,7 +1382,7 @@ The complete implementations can be found in the working [example repositories](
1382
1382
  </TabItem>
1383
1383
  <TabItem value="Sanity" label="Sanity">
1384
1384
 
1385
- :::tip Working Example
1385
+ :::tip[Working Example]
1386
1386
  The complete, production-ready Sanity implementation can be found in the [Sanity integration example](https://github.com/vendurehq/examples/tree/master/examples/sanity-cms-integration). It includes advanced features like content type management and bulk operations.
1387
1387
  :::
1388
1388
 
@@ -1647,7 +1647,7 @@ https://github.com/vendurehq/examples/tree/master/examples/sanity-cms-integratio
1647
1647
  </TabItem>
1648
1648
  <TabItem value="payload" label="Payload">
1649
1649
 
1650
- :::tip Working Example
1650
+ :::tip[Working Example]
1651
1651
  The complete, production-ready Payload implementation can be found in the [Payload integration example](https://github.com/vendurehq/examples/tree/master/examples/payload-cms-integration). It includes advanced features like local API communication, collection management, and relationship handling.
1652
1652
  :::
1653
1653
 
@@ -153,7 +153,7 @@ export class OrganizationService {
153
153
 
154
154
  ## Codegen for Admin UI extensions
155
155
 
156
- :::warning Deprecated
156
+ :::warning[Deprecated]
157
157
  This section refers to the deprecated Angular-based Admin UI. The new React-based Dashboard has built-in graphql type safety
158
158
  and does not require additional setup.
159
159
  :::
@@ -4,7 +4,7 @@ generated: true
4
4
  ---
5
5
  <GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="147" packageName="@vendure/admin-ui-plugin" />
6
6
 
7
- :::warning Deprecated
7
+ :::warning[Deprecated]
8
8
  From Vendure v3.5.0, the Angular-based Admin UI has been replaced by the new [React Admin Dashboard](/extending-the-dashboard/getting-started/).
9
9
  The Angular Admin UI will not be maintained after **July 2026**. Until then, we will continue patching critical bugs and security issues.
10
10
  Community contributions will always be merged and released.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vendure/docs",
3
- "version": "0.0.0-202601271334",
3
+ "version": "0.0.0-202601280949",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -29,7 +29,7 @@
29
29
  "typecheck": "tsc --noEmit"
30
30
  },
31
31
  "dependencies": {
32
- "@vendure-io/docs-provider": "^0.8.2"
32
+ "@vendure-io/docs-provider": "^0.9.0"
33
33
  },
34
34
  "devDependencies": {
35
35
  "rimraf": "^5.0.5",
@@ -1,5 +1,5 @@
1
1
  // dates.generated.ts (auto-generated, do not edit)
2
- // Generated at: 2026-01-27T12:34:43.366Z
2
+ // Generated at: 2026-01-28T08:50:01.721Z
3
3
  // Total files: 805
4
4
 
5
5
  export const lastModifiedDates: Record<string, string> = {
@@ -79,7 +79,7 @@ export const lastModifiedDates: Record<string, string> = {
79
79
  'docs/guides/extending-the-admin-ui/custom-timeline-components/index.mdx': '2026-01-27T13:31:29+01:00',
80
80
  'docs/guides/extending-the-admin-ui/dashboard-widgets/index.mdx': '2026-01-27T13:31:29+01:00',
81
81
  'docs/guides/extending-the-admin-ui/defining-routes/index.mdx': '2026-01-27T13:31:29+01:00',
82
- 'docs/guides/extending-the-admin-ui/getting-started/index.mdx': '2026-01-27T13:31:29+01:00',
82
+ 'docs/guides/extending-the-admin-ui/getting-started/index.mdx': '2026-01-28T09:24:47+01:00',
83
83
  'docs/guides/extending-the-admin-ui/nav-menu/index.mdx': '2026-01-27T13:31:29+01:00',
84
84
  'docs/guides/extending-the-admin-ui/page-tabs/index.mdx': '2026-01-16T19:58:56+01:00',
85
85
  'docs/guides/extending-the-admin-ui/ui-library/index.mdx': '2026-01-16T19:58:56+01:00',
@@ -90,7 +90,7 @@ export const lastModifiedDates: Record<string, string> = {
90
90
  'docs/guides/extending-the-dashboard/creating-pages/list-pages.mdx': '2026-01-27T13:31:29+01:00',
91
91
  'docs/guides/extending-the-dashboard/creating-pages/tabbed-pages.mdx': '2026-01-27T13:31:29+01:00',
92
92
  'docs/guides/extending-the-dashboard/custom-form-components/form-component-examples.mdx': '2026-01-16T19:58:56+01:00',
93
- 'docs/guides/extending-the-dashboard/custom-form-components/index.mdx': '2026-01-27T13:31:29+01:00',
93
+ 'docs/guides/extending-the-dashboard/custom-form-components/index.mdx': '2026-01-28T09:24:47+01:00',
94
94
  'docs/guides/extending-the-dashboard/custom-form-components/relation-selectors.mdx': '2026-01-16T19:58:56+01:00',
95
95
  'docs/guides/extending-the-dashboard/customizing-pages/action-bar-items.mdx': '2026-01-27T13:31:29+01:00',
96
96
  'docs/guides/extending-the-dashboard/customizing-pages/customizing-detail-pages.mdx': '2026-01-27T13:31:29+01:00',
@@ -99,21 +99,21 @@ export const lastModifiedDates: Record<string, string> = {
99
99
  'docs/guides/extending-the-dashboard/customizing-pages/history-entries.mdx': '2026-01-16T19:58:56+01:00',
100
100
  'docs/guides/extending-the-dashboard/customizing-pages/index.mdx': '2026-01-27T13:31:29+01:00',
101
101
  'docs/guides/extending-the-dashboard/customizing-pages/insights-widgets.mdx': '2026-01-16T19:58:56+01:00',
102
- 'docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx': '2026-01-27T13:31:29+01:00',
102
+ 'docs/guides/extending-the-dashboard/customizing-pages/page-blocks.mdx': '2026-01-28T09:24:47+01:00',
103
103
  'docs/guides/extending-the-dashboard/data-fetching/index.mdx': '2026-01-27T13:31:29+01:00',
104
- 'docs/guides/extending-the-dashboard/deployment/index.mdx': '2026-01-16T19:58:56+01:00',
104
+ 'docs/guides/extending-the-dashboard/deployment/index.mdx': '2026-01-28T09:24:47+01:00',
105
105
  'docs/guides/extending-the-dashboard/extending-overview/index.mdx': '2026-01-27T13:31:29+01:00',
106
- 'docs/guides/extending-the-dashboard/getting-started/index.mdx': '2026-01-16T19:58:56+01:00',
106
+ 'docs/guides/extending-the-dashboard/getting-started/index.mdx': '2026-01-28T09:24:47+01:00',
107
107
  'docs/guides/extending-the-dashboard/localization/index.mdx': '2026-01-16T17:06:22+01:00',
108
108
  'docs/guides/extending-the-dashboard/migration/index.mdx': '2026-01-27T13:31:29+01:00',
109
- 'docs/guides/extending-the-dashboard/navigation/index.mdx': '2026-01-27T13:31:29+01:00',
109
+ 'docs/guides/extending-the-dashboard/navigation/index.mdx': '2026-01-28T09:24:47+01:00',
110
110
  'docs/guides/extending-the-dashboard/tech-stack/index.mdx': '2026-01-16T19:58:56+01:00',
111
111
  'docs/guides/extending-the-dashboard/theming/index.mdx': '2026-01-16T19:58:56+01:00',
112
112
  'docs/guides/getting-started/graphql-intro/index.mdx': '2026-01-27T13:31:29+01:00',
113
113
  'docs/guides/getting-started/installation/index.mdx': '2026-01-27T13:31:29+01:00',
114
114
  'docs/guides/getting-started/try-the-api/index.mdx': '2026-01-27T13:31:29+01:00',
115
- 'docs/guides/how-to/cms-integration-plugin/index.mdx': '2026-01-27T13:31:29+01:00',
116
- 'docs/guides/how-to/codegen/index.mdx': '2026-01-27T13:31:29+01:00',
115
+ 'docs/guides/how-to/cms-integration-plugin/index.mdx': '2026-01-28T09:24:47+01:00',
116
+ 'docs/guides/how-to/codegen/index.mdx': '2026-01-28T09:24:47+01:00',
117
117
  'docs/guides/how-to/configurable-products/index.mdx': '2026-01-27T13:31:29+01:00',
118
118
  'docs/guides/how-to/digital-products/index.mdx': '2026-01-27T13:31:29+01:00',
119
119
  'docs/guides/how-to/github-oauth-authentication/index.mdx': '2026-01-27T13:31:29+01:00',
@@ -261,7 +261,7 @@ export const lastModifiedDates: Record<string, string> = {
261
261
  'docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx': '2026-01-21T10:28:03+01:00',
262
262
  'docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx': '2026-01-21T10:28:03+01:00',
263
263
  'docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx': '2026-01-21T10:28:03+01:00',
264
- 'docs/reference/core-plugins/admin-ui-plugin/index.mdx': '2026-01-27T13:31:29+01:00',
264
+ 'docs/reference/core-plugins/admin-ui-plugin/index.mdx': '2026-01-28T09:24:47+01:00',
265
265
  'docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx': '2026-01-21T10:28:03+01:00',
266
266
  'docs/reference/core-plugins/asset-server-plugin/cache-config.mdx': '2026-01-21T10:28:03+01:00',
267
267
  'docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx': '2026-01-21T14:47:34+01:00',