docs: general updates to documentation pages (#13128)

2025-08-01 18:59:46 +03:00
parent 522fc12d7a
commit 89886ba518
13 changed files with 126 additions and 36 deletions
@@ -10,6 +10,8 @@ export const metadata = {

 # {metadata.title}

+In this guide, you'll learn how to add an action menu to your Medusa Admin customizations.
+
 The Medusa Admin often provides additional actions in a dropdown shown when users click a three-dot icon.

 ![Example of an action menu in the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728291319/Medusa%20Resources/action-menu_jnus6k.png)
@@ -8,6 +8,8 @@ export const metadata = {

 # {metadata.title}

+In this guide, you'll learn how to create a container component that matches the Medusa Admin's design conventions.
+
 The Medusa Admin wraps each section of a page in a container.

 ![Example of a container in the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728287102/Medusa%20Resources/container_soenir.png)
@@ -8,6 +8,8 @@ export const metadata = {

 # {metadata.title}

+In this guide, you'll learn how to create forms that match the Medusa Admin's design conventions.
+
 The Medusa Admin has two types of forms:

 1. Create forms, created using the [FocusModal UI component](!ui!/components/focus-modal).
@@ -59,7 +61,7 @@ export const CreateForm = () => {
  })

  const handleSubmit = form.handleSubmit(({ name }) => {
-    // TODO submit to backend
+    // TODO: submit to backend
    console.log(name)
  })

@@ -127,7 +129,7 @@ export const CreateForm = () => {

 Unlike other components in this documentation, this form component isn't reusable. You have to create one for every resource that has a create form in the admin.

-Start by creating the file `src/admin/components/create-form.tsx` that you'll create the form in.
+Start by creating the file `src/admin/components/create-form.tsx` in which you'll create the form.

 ### Create Validation Schema

@@ -163,7 +165,7 @@ export const CreateForm = () => {
  })

  const handleSubmit = form.handleSubmit(({ name }) => {
-    // TODO submit to backend
+    // TODO: submit to backend
    console.log(name)
  })

@@ -344,7 +346,7 @@ export const EditForm = () => {
  })

  const handleSubmit = form.handleSubmit(({ name }) => {
-    // TODO submit to backend
+    // TODO: submit to backend
    console.log(name)
  })

@@ -406,7 +408,7 @@ export const EditForm = () => {

 Unlike other components in this documentation, this form component isn't reusable. You have to create one for every resource that has an edit form in the admin.

-Start by creating the file `src/admin/components/edit-form.tsx` that you'll create the form in.
+Start by creating the file `src/admin/components/edit-form.tsx` in which you'll create the form.

 ### Create Validation Schema

@@ -442,7 +444,7 @@ export const EditForm = () => {
  })

  const handleSubmit = form.handleSubmit(({ name }) => {
-    // TODO submit to backend
+    // TODO: submit to backend
    console.log(name)
  })

@@ -10,6 +10,8 @@ export const metadata = {

 # {metadata.title}

+In this guide, you'll learn how to create a header component that matches the Medusa Admin's design conventions.
+
 Each section in the Medusa Admin has a header with a title, and optionally a subtitle with buttons to perform an action.

 ![Example of a header in a section](https://res.cloudinary.com/dza7lstvk/image/upload/v1728288562/Medusa%20Resources/header_dtz4gl.png)
@@ -10,6 +10,8 @@ export const metadata = {

 # {metadata.title}

+In this guide, you'll learn how to create a JSON view section that matches the Medusa Admin's design conventions.
+
 Detail pages in the Medusa Admin show a JSON section to view the current page's details in JSON format.

 ![Example of a JSON section in the admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728295129/Medusa%20Resources/json_dtbsgm.png)
@@ -10,6 +10,8 @@ export const metadata = {

 # {metadata.title}

+In this guide, you'll learn how to create a section row component that matches the Medusa Admin's design conventions.
+
 The Medusa Admin often shows information in rows of label-values, such as when showing a product's details.

 ![Example of a section row in the Medusa Admin](https://res.cloudinary.com/dza7lstvk/image/upload/v1728292781/Medusa%20Resources/section-row_kknbnw.png)