asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: update user guide introduction page (#11474)

Browse Source 
* docs: update user guide introduction page

* chore: run yarn prep automatically
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-02-14 16:15:28 +02:00
1 parent 5dc8a403ef
commit 10081118a5
14 files changed
+944 -328
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/book/public/llms-full.txt
+758 -255
View File
File diff suppressed because it is too large. Load diff
www/apps/user-guide/app/globals.css
+5 -1
View File
@@ -17,10 +17,14 @@
@apply bg-medusa-bg-highlight; @apply bg-medusa-bg-highlight;
} }
* { *:not(.code-block-elm) {
scrollbar-color: var(--docs-border-base) var(--docs-bg-base); scrollbar-color: var(--docs-border-base) var(--docs-bg-base);
} }
.code-block-elm {
scrollbar-color: var(--docs-contrast-border-base) transparent;
}
aside * { aside * {
scrollbar-color: var(--docs-border-base) var(--docs-bg-subtle); scrollbar-color: var(--docs-border-base) var(--docs-bg-subtle);
} }
www/apps/user-guide/app/layout.tsx
+1 -1
View File
@@ -1,7 +1,7 @@
import type { Metadata } from "next" import type { Metadata } from "next"
import { Inter, Roboto_Mono } from "next/font/google" import { Inter, Roboto_Mono } from "next/font/google"
import Providers from "@/providers" import Providers from "@/providers"
import "../css/globals.css" import "./globals.css"
import { BareboneLayout, TightLayout } from "docs-ui" import { BareboneLayout, TightLayout } from "docs-ui"
import { config } from "@/config" import { config } from "@/config"
import clsx from "clsx" import clsx from "clsx"
www/apps/user-guide/app/page.mdx
+47 -42
View File
@@ -6,21 +6,31 @@ export const metadata = {
# {metadata.title} # {metadata.title}
This user guide is intended to help users learn how they can use the Medusa Admin to perform different operational and ecommerce tasks. Welcome to the Medusa Admin user guide. This user guide is intended to help admin users learn how they can use the Medusa Admin to perform commerce operations and manage their store.
{/* TODO change image */} {/* TODO update photo */}
![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1710228410/User%20Guide/Screenshot_2024-03-12_at_9.24.45_AM_wllqvq.png) ![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.35_PM_ecyltl.png)
## Who is this guide for?
This guide is for Medusa Admin users looking to master the Medusa Admin and manage their store effectively. You don't need any technical knowledge to follow these guides.
You can also follow this guide if you're exploring Medusa and its operational features.
<Note>
For technical users, learn how to build and customize Medusa in [this documentation](!docs!/learn).
</Note>
## Access the Medusa Admin ## Access the Medusa Admin
To access the admin panel of your ecommerce store, open the URL of your local or deployed website. To access the admin panel of your ecommerce store, open the URL of your local or deployed website. You’ll be asked to log in.
You’ll be asked to log in. ![Log In Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739526611/User%20Guide/Screenshot_2025-02-14_at_11.45.35_AM_j1gepy.png)
![Log In Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1710228558/User%20Guide/Screenshot_2024-03-12_at_9.29.08_AM_cqjgq3.png) You must use your user’s email and password to log in. If you’re unsure what your email and password are, please contact the technical team that deployed your Medusa application.
You must use your user’s email and password to log in. If you’re unsure what your email and password are, please contact the technical personnel that deployed your Medusa application and admin.
<Note title="Technical Tip"> <Note title="Technical Tip">
@@ -30,35 +40,42 @@ Refer to [this documentation](!resources!/medusa-cli#user) on how to create a us
## Tour of Medusa Admin ## Tour of Medusa Admin
After you log into your Medusa Admin, you see a sidebar menu to the left, a search bar at the top, some icons at the top right, and in the middle the content of the page you’re currently on. After you log into your Medusa Admin, you see a sidebar menu to the left with a search bar at its top, a <InlineIcon Icon={BellAlert} alt="bell" /> at the top right, and in the middle the content of the page you’re currently on.
### Sidebar Menu ### Sidebar Menu
The sidebar menu includes the main navigation of your Medusa Admin. You can use it to navigate between different pages, such as Products or Orders pages. The sidebar menu includes the main navigation of your Medusa Admin. You can use it to navigate between different pages, such as Products or Orders pages.
{/* TODO update image */} ![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529281/User%20Guide/Screenshot_2025-02-14_at_12.34.22_PM_oeyaol.png)
![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1697793775/Medusa%20Docs/User%20Guide/Screenshot_2023-10-20_at_12.22.43_PM_shbr0e.png)
You can hide the sidebar by clicking the <InlineIcon Icon={SidebarLeft} alt="sidebar" /> icon at the top next to the sidebar. Clicking it again shows the sidebar. You can hide the sidebar by clicking the <InlineIcon Icon={SidebarLeft} alt="sidebar" /> icon at the top next to the sidebar. Clicking it again shows the sidebar.
### Sidebar Shortcuts
Sidebar items have shortcuts. For example, the Products page has a <Kbd>G</Kbd> then <Kbd>P</Kbd> shortcut. To view the shortcut of an item, hover your mouse for a few seconds and a tooltip will appear with the shortcut.
![Sidebar Shortcuts](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530172/User%20Guide/Screenshot_2025-02-14_at_12.48.19_PM_moyjtv.png)
You can also find all shortcuts by clicking on your profile item at the bottom of the sidebar and choosing "Shortcuts".
### Settings and Quick Actions
At the bottom of the sidebar you'll find a Settings item, which takes you to further settings of your store such as Region and Sales Channel management. You'll also find your avatar and name.
![Settings and profile](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530277/User%20Guide/Screenshot_2025-02-14_at_12.51.06_PM_lq0ehf.png)
By clicking on your avatar and name, you'll view quick actions such as going to profile settings, view shortcuts, or changing the admin theme.
![Profile Quick Actions](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530277/User%20Guide/Screenshot_2025-02-14_at_12.50.50_PM_qqmw54.png)
### Search Bar ### Search Bar
You’ll find at the top of the page a search bar. Use this search bar to search orders, products, customers, and more information available in your Medusa Admin. At the top of the sidebar, you'll find a search item. You can also open the search window using the shortcuts:
<Note title="Tip"> - Windows and Linux: <Kbd>CTRL</Kbd> + <Kbd>K</Kbd>
- Mac OS: <Kbd>⌘</Kbd> + <Kbd>K</Kbd>
You can open the search window using the shortcuts: ![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529553/User%20Guide/Screenshot_2025-02-14_at_12.36.53_PM_vps6cm.png)
Windows and Linux: <Kbd>CTRL</Kbd> + <Kbd>K</Kbd>
Mac OS: <Kbd>⌘</Kbd> + <Kbd>K</Kbd>
</Note>
{/* TODO check if image needs updating */}
![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1710228839/User%20Guide/Screenshot_2024-03-12_at_9.33.46_AM_ywdvpb.png)
You can select a result with your mouse, or use the up and down arrows on your keyboard to navigate between the results, then choose a result by hitting the <Kbd>Enter</Kbd> key. You can select a result with your mouse, or use the up and down arrows on your keyboard to navigate between the results, then choose a result by hitting the <Kbd>Enter</Kbd> key.
@@ -66,9 +83,7 @@ You can select a result with your mouse, or use the up and down arrows on your k
At the top right you’ll find a <InlineIcon Icon={BellAlert} alt="Bell" /> icon. Clicking this icon opens a side window to view any notifications you might have. Use this to view notifications such as completed product exports. At the top right you’ll find a <InlineIcon Icon={BellAlert} alt="Bell" /> icon. Clicking this icon opens a side window to view any notifications you might have. Use this to view notifications such as completed product exports.
{/* TODO change images */} ![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529955/User%20Guide/Screenshot_2025-02-14_at_12.45.44_PM_ljdvof.png)
![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1710243446/User%20Guide/XS_from_Figma_mkn3i2.jpg)
### Change Language ### Change Language
@@ -76,20 +91,10 @@ The Medusa Admin supports multiple-languages, with English being the default one
Learn how to change the language in [this guide](./settings/profile/page.mdx#change-admin-language). Learn how to change the language in [this guide](./settings/profile/page.mdx#change-admin-language).
### Quick Actions ### Change Admin Theme
At the top right in the sidebar, you’ll find an avatar icon with your email or name. By clicking this icon, you’ll see a dropdown. Use this dropdown to access settings or sign out. The Medusa Admin comes in light and dark themes. You can change the theme by clicking the profile item at the bottom of the sidebar -> Theme -> Light, Dark, or System, defaulting to your Operating System or Browser theme.
{/* TODO check if image needs updating */} {/* TODO add dark theme */}
![Quick Actions Dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1710229778/User%20Guide/Screenshot_2024-03-12_at_9.49.26_AM_j3f1pu.png) ![Dark Theme](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.56_PM_fdcgmz.png)
### Change Theme
The Medusa Admin supports both light and dark modes.
![Dark mode](https://res.cloudinary.com/dza7lstvk/image/upload/v1710323255/User%20Guide/Screenshot_2024-03-13_at_11.46.52_AM_atvw1e.png)
You can switch the theme by opening the quick actions dropdown, choosing theme, then choosing the prefered mode.
![Switch modes](https://res.cloudinary.com/dza7lstvk/image/upload/v1710323157/User%20Guide/Screenshot_2024-03-13_at_11.43.01_AM_giyhto.png)
www/apps/user-guide/css/globals.css
-22
View File
@@ -1,22 +0,0 @@
@tailwind base;
@tailwind components;
@tailwind utilities;
@layer base {
html {
-webkit-font-smoothing: antialiased;
}
body {
@apply overflow-x-hidden;
}
*::selection {
@apply bg-medusa-bg-highlight;
}
body[data-modal="opened"] {
@apply !overflow-hidden;
}
}
www/apps/user-guide/eslint.config.mjs
+1
View File
@@ -28,6 +28,7 @@ export default [
"**/node_modules", "**/node_modules",
"**/public", "**/public",
"**/.eslintrc.js", "**/.eslintrc.js",
"generated",
], ],
}, },
...compat.extends( ...compat.extends(
www/apps/user-guide/generated/edit-dates.mjs
+60
View File
@@ -0,0 +1,60 @@
export const generatedEditDates = {
"app/tips/languages/page.mdx": "2024-05-03T17:36:38+03:00",
"app/tips/bulk-editor/page.mdx": "2024-05-03T17:36:38+03:00",
"app/tips/lists/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/users/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/taxes/tax-rates/page.mdx": "2024-05-03T17:36:38+03:00",
"app/page.mdx": "2025-02-14T11:18:46.636Z",
"app/settings/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/export/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/return-reasons/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/shipping-options/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/users/invites/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/taxes/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/taxes/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/profile/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/countries/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/store/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/gift-cards/product-gift-card/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/import/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/create/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/regions/providers/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/locations/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/api-key-management/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/categories/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/exchange/page.mdx": "2024-05-03T17:36:38+03:00",
"app/inventory/reservations/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/api-key-management/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/gift-cards/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/gift-cards/customer-gift-card/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/discounts/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/pricing/_import/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/sales-channels/products/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00",
"app/inventory/inventory/page.mdx": "2024-05-03T17:36:38+03:00",
"app/customers/groups/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/returns/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/export/page.mdx": "2024-05-03T17:36:38+03:00",
"app/inventory/page.mdx": "2024-05-03T17:36:38+03:00",
"app/settings/sales-channels/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/claims/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/fulfillments/page.mdx": "2024-05-03T17:36:38+03:00",
"app/customers/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/edit/page.mdx": "2024-05-03T17:36:38+03:00",
"app/products/collections/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/drafts/page.mdx": "2024-05-03T17:36:38+03:00",
"app/customers/manage/page.mdx": "2024-05-03T17:36:38+03:00",
"app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00",
"app/orders/payments/page.mdx": "2024-05-03T17:36:38+03:00",
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00"
}
www/apps/user-guide/generated/sidebar.mjs
+49
View File
@@ -24,6 +24,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/tips/bulk-editor", "path": "/tips/bulk-editor",
"title": "Bulk Editor", "title": "Bulk Editor",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -32,6 +33,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/tips/languages", "path": "/tips/languages",
"title": "Admin Languages", "title": "Admin Languages",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -40,6 +42,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/tips/lists", "path": "/tips/lists",
"title": "Lists", "title": "Lists",
"description": "",
"children": [] "children": []
} }
] ]
@@ -59,6 +62,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/manage", "path": "/orders/manage",
"title": "Manage Details", "title": "Manage Details",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -67,6 +71,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/payments", "path": "/orders/payments",
"title": "Manage Payments", "title": "Manage Payments",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -75,6 +80,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/fulfillments", "path": "/orders/fulfillments",
"title": "Manage Fulfillments", "title": "Manage Fulfillments",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -83,6 +89,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/edit", "path": "/orders/edit",
"title": "Edit an Order’s Items", "title": "Edit an Order’s Items",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -91,6 +98,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/drafts", "path": "/orders/drafts",
"title": "Manage Draft Orders", "title": "Manage Draft Orders",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -99,6 +107,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/returns", "path": "/orders/returns",
"title": "Manage Returns", "title": "Manage Returns",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -107,6 +116,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/exchange", "path": "/orders/exchange",
"title": "Manage Exchanges", "title": "Manage Exchanges",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -115,6 +125,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/claims", "path": "/orders/claims",
"title": "Manage Order's Claims", "title": "Manage Order's Claims",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -123,6 +134,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/orders/export", "path": "/orders/export",
"title": "Export Orders", "title": "Export Orders",
"description": "",
"children": [] "children": []
} }
] ]
@@ -142,6 +154,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/manage", "path": "/products/manage",
"title": "Manage Products", "title": "Manage Products",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -150,6 +163,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/collections", "path": "/products/collections",
"title": "Manage Product Collections", "title": "Manage Product Collections",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -158,6 +172,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/categories", "path": "/products/categories",
"title": "Manage Product Categories", "title": "Manage Product Categories",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -166,6 +181,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/gift-cards", "path": "/products/gift-cards",
"title": "Gift Cards", "title": "Gift Cards",
"description": "",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -173,6 +189,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/gift-cards/product-gift-card", "path": "/products/gift-cards/product-gift-card",
"title": "Manage a Product Gift Card", "title": "Manage a Product Gift Card",
"description": "",
"children": [], "children": [],
"sidebar_position": 1 "sidebar_position": 1
}, },
@@ -182,6 +199,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/gift-cards/customer-gift-card", "path": "/products/gift-cards/customer-gift-card",
"title": "Manage a Customer Gift Card", "title": "Manage a Customer Gift Card",
"description": "",
"children": [], "children": [],
"sidebar_position": 2 "sidebar_position": 2
} }
@@ -193,6 +211,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/import", "path": "/products/import",
"title": "Import Products", "title": "Import Products",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -201,6 +220,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/products/export", "path": "/products/export",
"title": "Export Products", "title": "Export Products",
"description": "",
"children": [] "children": []
} }
] ]
@@ -220,6 +240,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/inventory/inventory", "path": "/inventory/inventory",
"title": "Manage Inventory", "title": "Manage Inventory",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -228,6 +249,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/inventory/reservations", "path": "/inventory/reservations",
"title": "Manage Reservations", "title": "Manage Reservations",
"description": "",
"children": [] "children": []
} }
] ]
@@ -247,6 +269,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/customers/manage", "path": "/customers/manage",
"title": "Manage Customers", "title": "Manage Customers",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -255,6 +278,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/customers/groups", "path": "/customers/groups",
"title": "Manage Customer Groups", "title": "Manage Customer Groups",
"description": "",
"children": [] "children": []
} }
] ]
@@ -274,6 +298,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/discounts/create", "path": "/discounts/create",
"title": "Create a Discount", "title": "Create a Discount",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -282,6 +307,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/discounts/manage", "path": "/discounts/manage",
"title": "Manage Discounts", "title": "Manage Discounts",
"description": "",
"children": [] "children": []
} }
] ]
@@ -301,6 +327,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/pricing/create", "path": "/pricing/create",
"title": "Create a Price List", "title": "Create a Price List",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -309,6 +336,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/pricing/manage", "path": "/pricing/manage",
"title": "Manage Price Lists", "title": "Manage Price Lists",
"description": "",
"children": [] "children": []
} }
] ]
@@ -328,6 +356,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/profile", "path": "/settings/profile",
"title": "Profile", "title": "Profile",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -336,6 +365,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/store", "path": "/settings/store",
"title": "Store", "title": "Store",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -344,6 +374,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/users", "path": "/settings/users",
"title": "Users", "title": "Users",
"description": "",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -351,6 +382,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/users/invites", "path": "/settings/users/invites",
"title": "Manage Invites", "title": "Manage Invites",
"description": "",
"children": [], "children": [],
"sidebar_position": 1 "sidebar_position": 1
} }
@@ -362,6 +394,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/regions", "path": "/settings/regions",
"title": "Regions", "title": "Regions",
"description": "",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -369,6 +402,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/regions/manage", "path": "/settings/regions/manage",
"title": "Manage Regions", "title": "Manage Regions",
"description": "",
"children": [], "children": [],
"sidebar_position": 1 "sidebar_position": 1
}, },
@@ -378,6 +412,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/regions/countries", "path": "/settings/regions/countries",
"title": "Manage Countries", "title": "Manage Countries",
"description": "",
"children": [], "children": [],
"sidebar_position": 2 "sidebar_position": 2
}, },
@@ -387,6 +422,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/regions/providers", "path": "/settings/regions/providers",
"title": "Manage Providers", "title": "Manage Providers",
"description": "",
"children": [], "children": [],
"sidebar_position": 3 "sidebar_position": 3
}, },
@@ -396,6 +432,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/regions/shipping-options", "path": "/settings/regions/shipping-options",
"title": "Manage Shipping Options", "title": "Manage Shipping Options",
"description": "",
"children": [], "children": [],
"sidebar_position": 4 "sidebar_position": 4
} }
@@ -407,6 +444,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/return-reasons", "path": "/settings/return-reasons",
"title": "Return Reasons", "title": "Return Reasons",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -415,6 +453,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/taxes", "path": "/settings/taxes",
"title": "Taxes", "title": "Taxes",
"description": "",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -422,6 +461,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/taxes/manage", "path": "/settings/taxes/manage",
"title": "Manage Taxes", "title": "Manage Taxes",
"description": "",
"children": [], "children": [],
"sidebar_position": 1 "sidebar_position": 1
}, },
@@ -431,6 +471,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/taxes/tax-rates", "path": "/settings/taxes/tax-rates",
"title": "Manage Tax Rates", "title": "Manage Tax Rates",
"description": "",
"children": [], "children": [],
"sidebar_position": 2 "sidebar_position": 2
} }
@@ -442,6 +483,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/locations", "path": "/settings/locations",
"title": "Locations", "title": "Locations",
"description": "",
"children": [] "children": []
}, },
{ {
@@ -450,6 +492,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/sales-channels", "path": "/settings/sales-channels",
"title": "Sales Channels", "title": "Sales Channels",
"description": "",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -457,6 +500,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/sales-channels/manage", "path": "/settings/sales-channels/manage",
"title": "Manage Sales Channels", "title": "Manage Sales Channels",
"description": "",
"children": [], "children": [],
"sidebar_position": 1 "sidebar_position": 1
}, },
@@ -466,6 +510,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/sales-channels/products", "path": "/settings/sales-channels/products",
"title": "Manage Products", "title": "Manage Products",
"description": "",
"children": [], "children": [],
"sidebar_position": 2 "sidebar_position": 2
} }
@@ -477,6 +522,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/developer", "path": "/settings/developer",
"title": "Developer", "title": "Developer",
"description": "",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -484,6 +530,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/developer/api-key-management", "path": "/settings/developer/api-key-management",
"title": "API Key Management", "title": "API Key Management",
"description": "",
"children": [ "children": [
{ {
"loaded": true, "loaded": true,
@@ -491,6 +538,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/developer/api-key-management/sales-channels", "path": "/settings/developer/api-key-management/sales-channels",
"title": "Manage Sales Channels", "title": "Manage Sales Channels",
"description": "",
"children": [], "children": [],
"sidebar_position": 1 "sidebar_position": 1
} }
@@ -503,6 +551,7 @@ export const generatedSidebar = [
"type": "link", "type": "link",
"path": "/settings/developer/executions", "path": "/settings/developer/executions",
"title": "Executions", "title": "Executions",
"description": "",
"children": [], "children": [],
"sidebar_position": 2 "sidebar_position": 2
} }
www/apps/user-guide/providers/index.tsx
+1
View File
@@ -53,6 +53,7 @@ const Providers = ({ children }: ProvidersProps) => {
<HooksLoader <HooksLoader
options={{ options={{
pageScrollManager: true, pageScrollManager: true,
currentLearningPath: false,
}} }}
> >
{children} {children}
www/apps/user-guide/providers/main-nav.tsx
+12 -1
View File
@@ -6,12 +6,15 @@ import {
} from "docs-ui" } from "docs-ui"
import { useMemo } from "react" import { useMemo } from "react"
import { config } from "../config" import { config } from "../config"
import { generatedEditDates } from "../generated/edit-dates.mjs"
import { usePathname } from "next/navigation"
type MainNavProviderProps = { type MainNavProviderProps = {
children?: React.ReactNode children?: React.ReactNode
} }
export const MainNavProvider = ({ children }: MainNavProviderProps) => { export const MainNavProvider = ({ children }: MainNavProviderProps) => {
const pathname = usePathname()
const navigationDropdownItems = useMemo( const navigationDropdownItems = useMemo(
() => () =>
getNavDropdownItems({ getNavDropdownItems({
@@ -20,8 +23,16 @@ export const MainNavProvider = ({ children }: MainNavProviderProps) => {
[] []
) )
const editDate = useMemo(
() =>
(generatedEditDates as Record<string, string>)[
`app${pathname.replace(/\/$/, "")}/page.mdx`
],
[pathname]
)
return ( return (
<UiMainNavProvider navItems={navigationDropdownItems}> <UiMainNavProvider navItems={navigationDropdownItems} editDate={editDate}>
{children} {children}
</UiMainNavProvider> </UiMainNavProvider>
) )
www/apps/user-guide/scripts/prepare.mjs
+3 -2
View File
@@ -1,8 +1,9 @@
import { generateSidebar } from "build-scripts" import { generateEditedDates, generateSidebar } from "build-scripts"
import { sidebar } from "../sidebar.mjs" import { sidebar } from "../sidebar.mjs"
async function main() { async function main() {
generateSidebar(sidebar) await generateSidebar(sidebar)
await generateEditedDates()
} }
void main() void main()
www/packages/docs-ui/src/components/AiAssistant/ChatWindow/Footer/index.tsx
+2 -2
View File
@@ -16,10 +16,10 @@ export const AiAssistantChatWindowFooter = () => {
<div className="flex items-center gap-docs_0.5"> <div className="flex items-center gap-docs_0.5">
<span className="text-medusa-fg-subtle">Line break</span> <span className="text-medusa-fg-subtle">Line break</span>
<div className="flex items-center gap-[5px]"> <div className="flex items-center gap-[5px]">
<Kbd className="bg-medusa-bg-field-component border-medusa-border-strong w-[18px] h-[18px] inline-block"> <Kbd className="bg-medusa-bg-field-component border-medusa-border-strong w-[18px] h-[18px] inline-block p-0">
⇧ ⇧
</Kbd> </Kbd>
<Kbd className="bg-medusa-bg-field-component border-medusa-border-strong w-[18px] h-[18px] inline-block"> <Kbd className="bg-medusa-bg-field-component border-medusa-border-strong w-[18px] h-[18px] inline-block p-0">
↵ ↵
</Kbd> </Kbd>
</div> </div>
www/packages/docs-ui/src/components/InlineIcon/index.tsx
+4 -1
View File
@@ -11,7 +11,10 @@ export const InlineIcon = ({ Icon, alt, ...props }: InlineIconProps) => {
return ( return (
<Icon <Icon
{...props} {...props}
className={clsx("text-medusa-fg-subtle inline", props.className)} className={clsx(
"text-medusa-fg-subtle inline-block align-middle",
props.className
)}
aria-label={alt} aria-label={alt}
/> />
) )
www/packages/docs-ui/src/components/Kbd/index.tsx
+1 -1
View File
@@ -16,7 +16,7 @@ export const Kbd = ({
className={clsx( className={clsx(
"rounded-docs_xs border-solid border border-medusa-border-base", "rounded-docs_xs border-solid border border-medusa-border-base",
"inline-flex items-center justify-center", "inline-flex items-center justify-center",
"p-0", "px-docs_0.25",
"bg-medusa-bg-field", "bg-medusa-bg-field",
"text-medusa-fg-base", "text-medusa-fg-base",
"font-base shadow-none", "font-base shadow-none",