docs: update user guide introduction page (#11474)
* docs: update user guide introduction page * chore: run yarn prep automatically
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
5dc8a403ef
commit
10081118a5
14 files changed
+944
-328
No files matched your search
@@ -17,10 +17,14 @@
|
||||
@apply bg-medusa-bg-highlight;
|
||||
}
|
||||
|
||||
* {
|
||||
*:not(.code-block-elm) {
|
||||
scrollbar-color: var(--docs-border-base) var(--docs-bg-base);
|
||||
}
|
||||
|
||||
.code-block-elm {
|
||||
scrollbar-color: var(--docs-contrast-border-base) transparent;
|
||||
}
|
||||
|
||||
aside * {
|
||||
scrollbar-color: var(--docs-border-base) var(--docs-bg-subtle);
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import type { Metadata } from "next"
|
||||
import { Inter, Roboto_Mono } from "next/font/google"
|
||||
import Providers from "@/providers"
|
||||
import "../css/globals.css"
|
||||
import "./globals.css"
|
||||
import { BareboneLayout, TightLayout } from "docs-ui"
|
||||
import { config } from "@/config"
|
||||
import clsx from "clsx"
|
||||
|
||||
@@ -6,21 +6,31 @@ export const metadata = {
|
||||
|
||||
# {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 */}
|
||||
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
<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
|
||||
|
||||
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
|
||||
|
||||
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 */}
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
### 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:
|
||||
|
||||
Windows and Linux: <Kbd>CTRL</Kbd> + <Kbd>K</Kbd>
|
||||
|
||||
Mac OS: <Kbd>⌘</Kbd> + <Kbd>K</Kbd>
|
||||
|
||||
</Note>
|
||||
|
||||
{/* TODO check if image needs updating */}
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
{/* TODO change images */}
|
||||
|
||||
|
||||
|
||||
|
||||
### 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).
|
||||
|
||||
### 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 */}
|
||||
|
||||
|
||||
|
||||
### Change Theme
|
||||
|
||||
The Medusa Admin supports both light and dark modes.
|
||||
|
||||
|
||||
|
||||
You can switch the theme by opening the quick actions dropdown, choosing theme, then choosing the prefered mode.
|
||||
|
||||
|
||||
|
||||
Reference in new issue
Block a user