Skip to content

Commit 1008111

Browse files
authored
docs: update user guide introduction page (medusajs#11474)
* docs: update user guide introduction page * chore: run yarn prep automatically
1 parent 5dc8a40 commit 1008111

File tree

14 files changed

+995
-379
lines changed

14 files changed

+995
-379
lines changed

www/apps/book/public/llms-full.txt

Lines changed: 813 additions & 310 deletions
Large diffs are not rendered by default.

www/apps/user-guide/app/globals.css

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,14 @@
1717
@apply bg-medusa-bg-highlight;
1818
}
1919

20-
* {
20+
*:not(.code-block-elm) {
2121
scrollbar-color: var(--docs-border-base) var(--docs-bg-base);
2222
}
2323

24+
.code-block-elm {
25+
scrollbar-color: var(--docs-contrast-border-base) transparent;
26+
}
27+
2428
aside * {
2529
scrollbar-color: var(--docs-border-base) var(--docs-bg-subtle);
2630
}

www/apps/user-guide/app/layout.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { Metadata } from "next"
22
import { Inter, Roboto_Mono } from "next/font/google"
33
import Providers from "@/providers"
4-
import "../css/globals.css"
4+
import "./globals.css"
55
import { BareboneLayout, TightLayout } from "docs-ui"
66
import { config } from "@/config"
77
import clsx from "clsx"

www/apps/user-guide/app/page.mdx

Lines changed: 43 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,31 @@ export const metadata = {
66

77
# {metadata.title}
88

9-
This user guide is intended to help users learn how they can use the Medusa Admin to perform different operational and ecommerce tasks.
9+
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.
1010

11-
{/* TODO change image */}
11+
{/* TODO update photo */}
1212

13-
![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1710228410/User%20Guide/Screenshot_2024-03-12_at_9.24.45_AM_wllqvq.png)
13+
![Medusa Admin Overview](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.35_PM_ecyltl.png)
1414

15-
## Access the Medusa Admin
15+
## Who is this guide for?
16+
17+
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.
18+
19+
You can also follow this guide if you're exploring Medusa and its operational features.
1620

17-
To access the admin panel of your ecommerce store, open the URL of your local or deployed website.
21+
<Note>
1822

19-
You’ll be asked to log in.
23+
For technical users, learn how to build and customize Medusa in [this documentation](!docs!/learn).
2024

21-
![Log In Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1710228558/User%20Guide/Screenshot_2024-03-12_at_9.29.08_AM_cqjgq3.png)
25+
</Note>
26+
27+
## Access the Medusa Admin
2228

23-
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.
29+
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.
30+
31+
![Log In Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739526611/User%20Guide/Screenshot_2025-02-14_at_11.45.35_AM_j1gepy.png)
32+
33+
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.
2434

2535
<Note title="Technical Tip">
2636

@@ -30,66 +40,61 @@ Refer to [this documentation](!resources!/medusa-cli#user) on how to create a us
3040

3141
## Tour of Medusa Admin
3242

33-
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.
43+
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.
3444

3545
### Sidebar Menu
3646

3747
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.
3848

39-
{/* TODO update image */}
40-
41-
![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)
49+
![Sidebar Menu](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529281/User%20Guide/Screenshot_2025-02-14_at_12.34.22_PM_oeyaol.png)
4250

4351
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.
4452

45-
### Search Bar
53+
### Sidebar Shortcuts
4654

47-
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.
55+
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.
4856

49-
<Note title="Tip">
57+
![Sidebar Shortcuts](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530172/User%20Guide/Screenshot_2025-02-14_at_12.48.19_PM_moyjtv.png)
5058

51-
You can open the search window using the shortcuts:
59+
You can also find all shortcuts by clicking on your profile item at the bottom of the sidebar and choosing "Shortcuts".
5260

53-
Windows and Linux: <Kbd>CTRL</Kbd> + <Kbd>K</Kbd>
61+
### Settings and Quick Actions
5462

55-
Mac OS: <Kbd>⌘</Kbd> + <Kbd>K</Kbd>
63+
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.
5664

57-
</Note>
65+
![Settings and profile](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530277/User%20Guide/Screenshot_2025-02-14_at_12.51.06_PM_lq0ehf.png)
5866

59-
{/* TODO check if image needs updating */}
67+
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.
6068

61-
![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1710228839/User%20Guide/Screenshot_2024-03-12_at_9.33.46_AM_ywdvpb.png)
69+
![Profile Quick Actions](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530277/User%20Guide/Screenshot_2025-02-14_at_12.50.50_PM_qqmw54.png)
70+
71+
### Search Bar
72+
73+
At the top of the sidebar, you'll find a search item. You can also open the search window using the shortcuts:
74+
75+
- Windows and Linux: <Kbd>CTRL</Kbd> + <Kbd>K</Kbd>
76+
- Mac OS: <Kbd>⌘</Kbd> + <Kbd>K</Kbd>
77+
78+
![Search Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529553/User%20Guide/Screenshot_2025-02-14_at_12.36.53_PM_vps6cm.png)
6279

6380
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.
6481

6582
### Check Notifications
6683

6784
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.
6885

69-
{/* TODO change images */}
70-
71-
![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1710243446/User%20Guide/XS_from_Figma_mkn3i2.jpg)
86+
![Notifications Window](https://res.cloudinary.com/dza7lstvk/image/upload/v1739529955/User%20Guide/Screenshot_2025-02-14_at_12.45.44_PM_ljdvof.png)
7287

7388
### Change Language
7489

7590
The Medusa Admin supports multiple-languages, with English being the default one. Check out available languages [here](./tips/languages/page.mdx).
7691

7792
Learn how to change the language in [this guide](./settings/profile/page.mdx#change-admin-language).
7893

79-
### Quick Actions
80-
81-
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.
82-
83-
{/* TODO check if image needs updating */}
84-
85-
![Quick Actions Dropdown](https://res.cloudinary.com/dza7lstvk/image/upload/v1710229778/User%20Guide/Screenshot_2024-03-12_at_9.49.26_AM_j3f1pu.png)
86-
87-
### Change Theme
88-
89-
The Medusa Admin supports both light and dark modes.
94+
### Change Admin Theme
9095

91-
![Dark mode](https://res.cloudinary.com/dza7lstvk/image/upload/v1710323255/User%20Guide/Screenshot_2024-03-13_at_11.46.52_AM_atvw1e.png)
96+
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.
9297

93-
You can switch the theme by opening the quick actions dropdown, choosing theme, then choosing the prefered mode.
98+
{/* TODO add dark theme */}
9499

95-
![Switch modes](https://res.cloudinary.com/dza7lstvk/image/upload/v1710323157/User%20Guide/Screenshot_2024-03-13_at_11.43.01_AM_giyhto.png)
100+
![Dark Theme](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.56_PM_fdcgmz.png)

www/apps/user-guide/css/globals.css

Lines changed: 0 additions & 22 deletions
This file was deleted.

www/apps/user-guide/eslint.config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export default [
2828
"**/node_modules",
2929
"**/public",
3030
"**/.eslintrc.js",
31+
"generated",
3132
],
3233
},
3334
...compat.extends(
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
export const generatedEditDates = {
2+
"app/tips/languages/page.mdx": "2024-05-03T17:36:38+03:00",
3+
"app/tips/bulk-editor/page.mdx": "2024-05-03T17:36:38+03:00",
4+
"app/tips/lists/page.mdx": "2024-05-03T17:36:38+03:00",
5+
"app/settings/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
6+
"app/settings/users/page.mdx": "2024-05-03T17:36:38+03:00",
7+
"app/settings/regions/manage/page.mdx": "2024-05-03T17:36:38+03:00",
8+
"app/settings/taxes/tax-rates/page.mdx": "2024-05-03T17:36:38+03:00",
9+
"app/page.mdx": "2025-02-14T11:18:46.636Z",
10+
"app/settings/page.mdx": "2024-05-03T17:36:38+03:00",
11+
"app/products/export/page.mdx": "2024-05-03T17:36:38+03:00",
12+
"app/settings/return-reasons/page.mdx": "2024-05-03T17:36:38+03:00",
13+
"app/settings/regions/page.mdx": "2024-05-03T17:36:38+03:00",
14+
"app/settings/regions/shipping-options/page.mdx": "2024-05-03T17:36:38+03:00",
15+
"app/orders/page.mdx": "2024-05-03T17:36:38+03:00",
16+
"app/settings/users/invites/page.mdx": "2024-05-03T17:36:38+03:00",
17+
"app/settings/taxes/page.mdx": "2024-05-03T17:36:38+03:00",
18+
"app/settings/developer/page.mdx": "2024-05-03T17:36:38+03:00",
19+
"app/settings/taxes/manage/page.mdx": "2024-05-03T17:36:38+03:00",
20+
"app/settings/profile/page.mdx": "2024-05-03T17:36:38+03:00",
21+
"app/settings/regions/countries/page.mdx": "2024-05-03T17:36:38+03:00",
22+
"app/settings/store/page.mdx": "2024-05-03T17:36:38+03:00",
23+
"app/products/gift-cards/product-gift-card/page.mdx": "2024-05-03T17:36:38+03:00",
24+
"app/products/manage/page.mdx": "2024-05-03T17:36:38+03:00",
25+
"app/products/import/page.mdx": "2024-05-03T17:36:38+03:00",
26+
"app/pricing/create/page.mdx": "2024-05-03T17:36:38+03:00",
27+
"app/settings/regions/providers/page.mdx": "2024-05-03T17:36:38+03:00",
28+
"app/settings/locations/page.mdx": "2024-05-03T17:36:38+03:00",
29+
"app/settings/developer/api-key-management/page.mdx": "2024-05-03T17:36:38+03:00",
30+
"app/products/categories/page.mdx": "2024-05-03T17:36:38+03:00",
31+
"app/orders/exchange/page.mdx": "2024-05-03T17:36:38+03:00",
32+
"app/inventory/reservations/page.mdx": "2024-05-03T17:36:38+03:00",
33+
"app/settings/developer/api-key-management/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00",
34+
"app/products/gift-cards/page.mdx": "2024-05-03T17:36:38+03:00",
35+
"app/products/gift-cards/customer-gift-card/page.mdx": "2024-05-03T17:36:38+03:00",
36+
"app/pricing/page.mdx": "2024-05-03T17:36:38+03:00",
37+
"app/pricing/manage/page.mdx": "2024-05-03T17:36:38+03:00",
38+
"app/discounts/manage/page.mdx": "2024-05-03T17:36:38+03:00",
39+
"app/pricing/_import/page.mdx": "2024-05-03T17:36:38+03:00",
40+
"app/products/page.mdx": "2024-05-03T17:36:38+03:00",
41+
"app/settings/sales-channels/products/page.mdx": "2024-05-03T17:36:38+03:00",
42+
"app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00",
43+
"app/inventory/inventory/page.mdx": "2024-05-03T17:36:38+03:00",
44+
"app/customers/groups/page.mdx": "2024-05-03T17:36:38+03:00",
45+
"app/orders/manage/page.mdx": "2024-05-03T17:36:38+03:00",
46+
"app/orders/returns/page.mdx": "2024-05-03T17:36:38+03:00",
47+
"app/orders/export/page.mdx": "2024-05-03T17:36:38+03:00",
48+
"app/inventory/page.mdx": "2024-05-03T17:36:38+03:00",
49+
"app/settings/sales-channels/manage/page.mdx": "2024-05-03T17:36:38+03:00",
50+
"app/orders/claims/page.mdx": "2024-05-03T17:36:38+03:00",
51+
"app/orders/fulfillments/page.mdx": "2024-05-03T17:36:38+03:00",
52+
"app/customers/page.mdx": "2024-05-03T17:36:38+03:00",
53+
"app/orders/edit/page.mdx": "2024-05-03T17:36:38+03:00",
54+
"app/products/collections/page.mdx": "2024-05-03T17:36:38+03:00",
55+
"app/orders/drafts/page.mdx": "2024-05-03T17:36:38+03:00",
56+
"app/customers/manage/page.mdx": "2024-05-03T17:36:38+03:00",
57+
"app/discounts/create/page.mdx": "2024-05-03T17:36:38+03:00",
58+
"app/orders/payments/page.mdx": "2024-05-03T17:36:38+03:00",
59+
"app/discounts/page.mdx": "2024-05-03T17:36:38+03:00"
60+
}

0 commit comments

Comments
 (0)