Browse Source

docs: Some docs fixes

Michael Bromley 5 months ago
parent
commit
446436ddf2

+ 1 - 1
README.md

@@ -4,7 +4,7 @@ An open-source headless commerce platform built on [Node.js](https://nodejs.org)
 
 > [!IMPORTANT]
 > **We're introducing our new React-based Admin Dashboard**</br>
-> Check out our beta preview now: [v3.4.0 release notes](https://github.com/vendure-ecommerce/vendure/releases/tag/v3.4.0)</br>
+> Check out the preview now: [v3.4.0 release notes](https://github.com/vendure-ecommerce/vendure/releases/tag/v3.4.0)</br>
 > We're phasing out our Angular-based Admin UI with support until June 2026:
 > [Read more here](https://vendure.io/blog/2025/02/vendure-react-admin-ui)
 

+ 1 - 1
docs/docs/guides/extending-the-dashboard/action-bar-items/index.md

@@ -238,7 +238,7 @@ The dashboard provides several button variants you can use:
 
 To find the `pageId` for your action bar items:
 
-1. Enable [Dev Mode](/guides/extending-the-dashboard/getting-started/#dev-mode) in the dashboard
+1. Enable [Dev Mode](/guides/extending-the-dashboard/extending-overview/#dev-mode) in the dashboard
 2. Navigate to the page where you want to add your action
 3. The page ID will be shown in the dev mode overlay
 4. Use this ID in your action bar item configuration

+ 18 - 16
docs/docs/guides/extending-the-dashboard/extending-overview/index.md

@@ -75,7 +75,7 @@ Form handling in the dashboard is powered by [react-hook-form](https://react-hoo
 
 ```tsx
 import { useForm } from 'react-hook-form';
-import { FormFieldWrapper, Input, Button } from '@vendure/dashboard';
+import { Form, FormFieldWrapper, Input, Button } from '@vendure/dashboard';
 
 function MyForm() {
     const form = useForm({
@@ -90,21 +90,23 @@ function MyForm() {
     };
 
     return (
-        <form onSubmit={form.handleSubmit(onSubmit)}>
-            <FormFieldWrapper
-                control={form.control}
-                name="name"
-                label="Name"
-                render={({ field }) => <Input {...field} />}
-            />
-            <FormFieldWrapper
-                control={form.control}
-                name="email"
-                label="Email"
-                render={({ field }) => <Input type="email" {...field} />}
-            />
-            <Button type="submit">Submit</Button>
-        </form>
+        <Form {...form}>
+            <form onSubmit={form.handleSubmit(onSubmit)}>
+                <FormFieldWrapper
+                    control={form.control}
+                    name="name"
+                    label="Name"
+                    render={({ field }) => <Input {...field} />}
+                />
+                <FormFieldWrapper
+                    control={form.control}
+                    name="email"
+                    label="Email"
+                    render={({ field }) => <Input type="email" {...field} />}
+                />
+                <Button type="submit">Submit</Button>
+            </form>
+        </Form>
     );
 }
 ```

+ 4 - 6
docs/docs/guides/extending-the-dashboard/getting-started/index.md

@@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem';
 The `@vendure/dashboard` package is currently **RC.1** (release candiate) and can be used in production. There won't be any _major_ breaking API changes anymore. **The official release is targeted for the end of August 2025.**
 :::
 
-Our new React-based dashboard is currently in beta, and you can try it out now!
+Our new React-based dashboard is currently in the release candidate phase, and you can try it out now!
 
 The goal of the new dashboard:
 
@@ -18,7 +18,7 @@ The goal of the new dashboard:
 - Modern, AI-ready stack using React, Tailwind & Shadcn.
 - Built-in type-safety with zero extra configuration
 
-Because the dashboard is in beta, not all planned features are available yet. However, enough has been implemented that
+Because the dashboard is in the release candidate phase, not all planned features are available yet. However, enough has been implemented that
 you can try it out and give us feedback.
 
 ## Installation & Setup
@@ -54,7 +54,7 @@ export default defineConfig({
             // and custom fields that are configured.
             vendureConfigPath: pathToFileURL('./src/vendure-config.ts'),
             // Points to the location of your Vendure server.
-            uiConfig: { host: 'http://localhost', port: 3000 },
+            api: { host: 'http://localhost', port: 3000 },
             // When you start the Vite server, your Admin API schema will
             // be introspected and the types will be generated in this location.
             // These types can be used in your dashboard extensions to provide
@@ -149,9 +149,7 @@ We hope this gives you a taste of what is possible with the new dashboard.
 
 We're still working to bring feature-parity with the existing Admin UI - so support for things like:
 
-- bulk actions,
 - history timeline components
-- theming & branding
-- translations
+- translations of the dashboard itself
 
 The final release (expected Q3 2025) will also include much more extensive documentation & guides.

+ 1 - 1
docs/docs/guides/extending-the-dashboard/navigation/index.md

@@ -310,7 +310,7 @@ Common icons for navigation sections:
 :::info Discovering Section IDs
 To see what navigation sections are available, you can:
 
-1. Enable [Dev Mode](/guides/extending-the-dashboard/getting-started/#dev-mode) in the dashboard
+1. Enable [Dev Mode](/guides/extending-the-dashboard/extending-overview/#dev-mode) in the dashboard
 2. Examine the navigation sidebar to see section IDs
 3. Look at other plugins' navigation configuration for examples
    :::

+ 2 - 2
docs/docs/guides/extending-the-dashboard/page-blocks/index.md

@@ -3,7 +3,7 @@ title: 'Page Blocks'
 ---
 
 In the Dashboard, all pages are built from blocks. Every block has a `pageId` and a `blockId` which uniquely locates it in the
-app (see [Dev Mode](/guides/extending-the-dashboard/getting-started/#dev-mode) section).
+app (see [Dev Mode](/guides/extending-the-dashboard/extending-overview/#dev-mode) section).
 
 You can also define your own blocks, which can be added to any page and can even replace the default blocks.
 
@@ -180,7 +180,7 @@ export default defineDashboardExtension({
 
 To find the `pageId` and `blockId` values for positioning your blocks:
 
-1. Enable [Dev Mode](/guides/extending-the-dashboard/getting-started/#dev-mode) in the dashboard
+1. Enable [Dev Mode](/guides/extending-the-dashboard/extending-overview/#dev-mode) in the dashboard
 2. Navigate to the page where you want to add your block
 3. Hover over existing blocks to see their IDs
 4. Use these IDs in your block positioning configuration