docs: add user guide tags + sidebar links for commerce modules (#11612)

* add tags * docs: add tags for user guide + links in commerce modules sidebar * generate sidebar
medusajs · Feb 26, 2025 · cdfa21c · cdfa21c
1 parent fa1793e
commit cdfa21c
Show file tree

Hide file tree

Showing 111 changed files with 4,024 additions and 2,601 deletions.
diff --git a/www/apps/resources/generated/files-map.mjs b/www/apps/resources/generated/files-map.mjs
diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs
diff --git a/www/apps/resources/sidebars/api-key.mjs b/www/apps/resources/sidebars/api-key.mjs
@@ -59,7 +59,7 @@ export const apiKeySidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
+        title: "Admin User Guides",
         initialOpen: false,
         autogenerate_tags: "userGuide+apiKey",
         autogenerate_as_ref: true,

diff --git a/www/apps/resources/sidebars/auth.mjs b/www/apps/resources/sidebars/auth.mjs
@@ -91,8 +91,8 @@ export const authSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+auth",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+auth",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/cart.mjs b/www/apps/resources/sidebars/cart.mjs
@@ -76,8 +76,8 @@ export const cartSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+cart",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+cart",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/currency.mjs b/www/apps/resources/sidebars/currency.mjs
@@ -54,8 +54,8 @@ export const currencySidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+currency",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+currency",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/customer.mjs b/www/apps/resources/sidebars/customer.mjs
@@ -66,8 +66,8 @@ export const customerSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+customer",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+customer",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/fulfillment.mjs b/www/apps/resources/sidebars/fulfillment.mjs
@@ -93,8 +93,8 @@ export const fulfillmentSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+fulfillment",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+fulfillment",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/inventory.mjs b/www/apps/resources/sidebars/inventory.mjs
@@ -71,8 +71,8 @@ export const inventorySidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+inventory",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+inventory",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/order-module.mjs b/www/apps/resources/sidebars/order-module.mjs
@@ -104,8 +104,8 @@ export const orderSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+order",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+order",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/payment.mjs b/www/apps/resources/sidebars/payment.mjs
@@ -101,8 +101,8 @@ export const paymentSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+payment",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+payment",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/pricing.mjs b/www/apps/resources/sidebars/pricing.mjs
@@ -74,8 +74,8 @@ export const pricingSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+pricing",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+pricing",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/product.mjs b/www/apps/resources/sidebars/product.mjs
@@ -83,8 +83,8 @@ export const productSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+product",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+product",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/promotion.mjs b/www/apps/resources/sidebars/promotion.mjs
@@ -81,8 +81,8 @@ export const promotionSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+promotion",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+promotion",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/region.mjs b/www/apps/resources/sidebars/region.mjs
@@ -54,8 +54,8 @@ export const regionSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+region",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+region",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/sales-channel.mjs b/www/apps/resources/sidebars/sales-channel.mjs
@@ -61,8 +61,8 @@ export const salesChannelSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+salesChannel",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+salesChannel",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/stock-location.mjs b/www/apps/resources/sidebars/stock-location.mjs
@@ -61,8 +61,8 @@ export const stockLocationSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+stockLocation",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+stockLocation",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/store.mjs b/www/apps/resources/sidebars/store.mjs
@@ -54,8 +54,8 @@ export const storeSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+store",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+store",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/tax.mjs b/www/apps/resources/sidebars/tax.mjs
@@ -76,8 +76,8 @@ export const taxSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+tax",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+tax",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/resources/sidebars/user.mjs b/www/apps/resources/sidebars/user.mjs
@@ -54,8 +54,8 @@ export const userSidebar = [
       },
       {
         type: "category",
-        title: "User Guides",
-        autogenerate_tags: "userGuides+user",
+        title: "Admin User Guides",
+        autogenerate_tags: "userGuide+user",
         initialOpen: false,
         autogenerate_as_ref: true,
         description:

diff --git a/www/apps/user-guide/app/customers/groups/page.mdx b/www/apps/user-guide/app/customers/groups/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 2
+sidebar_label: "Manage Customer Groups"
+tags:
+    - user guide
+    - customer
 ---
 
 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"

diff --git a/www/apps/user-guide/app/customers/manage/page.mdx b/www/apps/user-guide/app/customers/manage/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 1
+sidebar_label: "Manage Customers"
+tags:
+    - user guide
+    - customer
 ---
 
 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"

diff --git a/www/apps/user-guide/app/customers/page.mdx b/www/apps/user-guide/app/customers/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_autogenerate_exclude: true
+sidebar_label: "Customers Overview"
+tags:
+    - user guide
+    - customer
 ---
 
 export const metadata = {

diff --git a/www/apps/user-guide/app/inventory/inventory/page.mdx b/www/apps/user-guide/app/inventory/inventory/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 1
+sidebar_label: "Manage Inventory Items"
+tags:
+    - user guide
+    - inventory
 ---
 
 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"

diff --git a/www/apps/user-guide/app/inventory/page.mdx b/www/apps/user-guide/app/inventory/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_autogenerate_exclude: true
+sidebar_label: "Inventory Overview"
+tags:
+    - user guide
+    - inventory
 ---
 
 export const metadata = {

diff --git a/www/apps/user-guide/app/inventory/reservations/page.mdx b/www/apps/user-guide/app/inventory/reservations/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 3
+sidebar_label: "Manage Reservations"
+tags:
+    - user guide
+    - inventory
 ---
 
 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"

diff --git a/www/apps/user-guide/app/orders/claims/page.mdx b/www/apps/user-guide/app/orders/claims/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 8
+sidebar_label: "Manage Order Claims"
+tags:
+    - user guide
+    - order
 ---
 
 import { 

diff --git a/www/apps/user-guide/app/orders/edit/page.mdx b/www/apps/user-guide/app/orders/edit/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 4
+sidebar_label: "Edit Order Items"
+tags:
+    - user guide
+    - order
 ---
 
 import { 

diff --git a/www/apps/user-guide/app/orders/exchanges/page.mdx b/www/apps/user-guide/app/orders/exchanges/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 7
+sidebar_label: "Manage Order Exchanges"
+tags:
+    - user guide
+    - order
 ---
 
 import { 

diff --git a/www/apps/user-guide/app/orders/fulfillments/page.mdx b/www/apps/user-guide/app/orders/fulfillments/page.mdx
@@ -1,6 +1,10 @@
 ---
 sidebar_position: 3
-sidebar_label: Manage Fulfillments
+sidebar_label: "Manage Order Fulfillments"
+tags:
+    - user guide
+    - order
+    - fulfillment
 ---
 
 import { 

diff --git a/www/apps/user-guide/app/orders/manage/page.mdx b/www/apps/user-guide/app/orders/manage/page.mdx
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 1
-sidebar_label: Manage Details
+sidebar_label: "Manage Order Details"
+tags:
+    - user guide
+    - order
 ---
 
 import { 

diff --git a/www/apps/user-guide/app/orders/page.mdx b/www/apps/user-guide/app/orders/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_autogenerate_exclude: true
+sidebar_label: "Orders Overview"
+tags:
+    - user guide
+    - order
 ---
 
 export const metadata = {

diff --git a/www/apps/user-guide/app/orders/payments/page.mdx b/www/apps/user-guide/app/orders/payments/page.mdx
@@ -1,6 +1,10 @@
 ---
 sidebar_position: 2
-sidebar_label: Manage Payments
+sidebar_label: "Manage Order Payments"
+tags:
+    - user guide
+    - order
+    - payment
 ---
 
 import { 

diff --git a/www/apps/user-guide/app/orders/returns/page.mdx b/www/apps/user-guide/app/orders/returns/page.mdx
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 6
-sidebar_label: Manage Returns
+sidebar_label: "Manage Order Returns"
+tags:
+    - user guide
+    - order
 ---
 
 import { 

diff --git a/www/apps/user-guide/app/price-lists/create/page.mdx b/www/apps/user-guide/app/price-lists/create/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 1
+sidebar_label: "Create a Price List"
+tags:
+    - user guide
+    - pricing
 ---
 
 import { EllipsisHorizontal } from "@medusajs/icons"

diff --git a/www/apps/user-guide/app/price-lists/manage/page.mdx b/www/apps/user-guide/app/price-lists/manage/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 2
+sidebar_label: "Manage Price Lists"
+tags:
+    - user guide
+    - pricing
 ---
 
 import { EllipsisHorizontal } from "@medusajs/icons"

diff --git a/www/apps/user-guide/app/price-lists/page.mdx b/www/apps/user-guide/app/price-lists/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_autogenerate_exclude: true
+sidebar_label: "Price Lists Overview"
+tags:
+    - user guide
+    - pricing
 ---
 
 export const metadata = {

diff --git a/www/apps/user-guide/app/products/categories/page.mdx b/www/apps/user-guide/app/products/categories/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 5
+sidebar_label: "Manage Product Categories"
+tags:
+    - user guide
+    - product
 ---
 
 import { DotsSix, TriangleRightMini, EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"

diff --git a/www/apps/user-guide/app/products/collections/page.mdx b/www/apps/user-guide/app/products/collections/page.mdx
@@ -1,5 +1,9 @@
 ---
 sidebar_position: 4
+sidebar_label: "Manage Product Collections"
+tags:
+    - user guide
+    - product
 ---
 
 import { EllipsisHorizontal,ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons"