From 647077057c35edaccac4aac46cfbe62725420ea9 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 19 Feb 2025 13:41:27 +0200 Subject: [PATCH] docs: update store user guide (#11530) --- www/apps/user-guide/app/settings/page.mdx | 28 ++- .../user-guide/app/settings/store/page.mdx | 77 ++++-- www/apps/user-guide/generated/edit-dates.mjs | 4 +- www/apps/user-guide/generated/sidebar.mjs | 219 ++++++------------ www/apps/user-guide/sidebar.mjs | 80 ++++++- 5 files changed, 232 insertions(+), 176 deletions(-) diff --git a/www/apps/user-guide/app/settings/page.mdx b/www/apps/user-guide/app/settings/page.mdx index dc2b9aa3ec..0a23c5b419 100644 --- a/www/apps/user-guide/app/settings/page.mdx +++ b/www/apps/user-guide/app/settings/page.mdx @@ -2,7 +2,7 @@ sidebar_autogenerate_exclude: true --- -import { CogSixTooth } from "@medusajs/icons" +import { ArrowUturnLeft } from "@medusajs/icons" export const metadata = { title: `Settings`, @@ -10,6 +10,28 @@ export const metadata = { # {metadata.title} -You can access your store's settings by clicking the icon at the top right of the page. +Your Medusa store's settings are where you can manage your store's details, regions, sales channels, and more. -This shows a settings panel with a different sidebar to manage your profile, store details, regions, and more. +You can access your store's settings by clicking "Settings" item at the bottom of the sidebar. This shows a settings panel with a different sidebar to manage your store's data. + +You can also go back to the main sidebar by clicking the icon at the top of the sidebar. + +![Settings Page](https://res.cloudinary.com/dza7lstvk/image/upload/v1739962494/User%20Guide/Screenshot_2025-02-19_at_12.54.00_PM_eozum8.png) + +--- + +## Manage Settings + +- [Manage Store](./store/page.mdx) +- [Manage Users](./users/page.mdx) +- [Manage Regions](./regions/page.mdx) +- [Manage Tax Regions](#) +- [Manage Return Reasons](./return-reasons/page.mdx) +- [Manage Sales Channels](./sales-channels/page.mdx) +- [Manage Product Types](#) +- [Manage Product Tags](#) +- [Manage Location & Shipping Settings](./locations/page.mdx) +- [Manage Publishable API Keys](#) +- [Manage Secret API Keys](#) +- [Manage Workflow Executions](./developer/executions/page.mdx) +- [Manage Profile](./profile/page.mdx) diff --git a/www/apps/user-guide/app/settings/store/page.mdx b/www/apps/user-guide/app/settings/store/page.mdx index 0c68ec978d..5799d2bd2a 100644 --- a/www/apps/user-guide/app/settings/store/page.mdx +++ b/www/apps/user-guide/app/settings/store/page.mdx @@ -3,7 +3,7 @@ sidebar_position: 2 sidebar_label: "Store" --- -import { EllipsisHorizontal } from "@medusajs/icons" +import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { title: `Manage Store`, @@ -11,41 +11,88 @@ export const metadata = { # {metadata.title} -In this document, you’ll learn how to edit the store’s details and available currencies. +In this guide, you’ll learn how to edit the store’s details and available currencies. + +## View Store Details + +To view your store's details, go to Settings → Store. There, you can view and manage the store's details and its available currencies. + +![Store Details](https://res.cloudinary.com/dza7lstvk/image/upload/v1739962494/User%20Guide/Screenshot_2025-02-19_at_12.54.00_PM_eozum8.png) + +--- ## Edit Store Details To edit the store’s details: 1. Go to Settings → Store. -2. Click the Edit button in the Store Selection. -3. In the drawer that opens, edit any of the store's details. -4. Once you're done, click the Save button. +2. Click the icon at the top right of the "Store" section. +3. Choose Edit from the dropdown. +4. In the side window that opens, you can edit the store's name, default currency, default region, default sales channel, and default location. These defaults are used in the storefront if no other values are provided. +5. Once you're done, click the Save button. + +![Edit store form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739962919/User%20Guide/Screenshot_2025-02-19_at_1.01.47_PM_l2zhnc.png) --- -## Add Currencies +## Manage Currencies + +Your store can support multiple currencies, allowing customers to view prices in their preferred currency. You can add or remove currencies in the store settings. + +### Add Currencies To add currencies to your store: 1. Go to Settings → Store. -2. Click on the Add button in the Currencies section. -3. In the form that opens, check the checkbox next to the currencies to add. -4. Once you're done, click the Save button. +2. Click the icon at the top right of the "Currencies" section. +3. Choose Add from the dropdown. +4. In the list that opens, check the currencies you want to add to the store. + - To enable [tax-inclusive pricing](#edit-tax-inclusive-setting-for-currency) for a currency, enable the toggle at the currency's right. +5. Once you're done, click the Save button. ---- +![Add currencies to store](https://res.cloudinary.com/dza7lstvk/image/upload/v1739963867/User%20Guide/Screenshot_2025-02-19_at_1.17.37_PM_mjrxng.png) -## Remove Currencies +### Edit Tax-Inclusive Setting for Currency - +In the store's settings, you can also manage a currency's tax-inclusive price setting. During checkout, after Medusa calculates the tax of a product or shipping, it will either: -If you remove a currency, you can still add it again in the future. +- Add the tax to the product's price (tax-exclusive pricing). +- Include the tax in the product's price (tax-inclusive pricing). - +You can manage whether a currency uses tax-inclusive pricing when adding or editing it. To edit the tax-inclusive setting for a currency: + +1. Go to Settings → Store. +2. Click the icon at the right of the currency you want to edit. +3. Choose "Enable tax-inclusive pricing" or "Disable tax-inclusive pricing" from the dropdown, depending on the current setting. + +### Remove Currencies + +You can remove any currency from your store that isn't the default currency. You can add the currency again later if needed. To remove a currency: 1. Go to Settings → Store. 2. Under the Currencies section, check the checkbox next to the currencies you want to remove. -3. Once you're done, press R to remove the currencies. +3. Press R or click the Remove button at the bottom center of the page. 4. Confirm removing the currencies by clicking the Remove button in the pop-up. + +![Remove currencies from store](https://res.cloudinary.com/dza7lstvk/image/upload/v1739963798/User%20Guide/Screenshot_2025-02-19_at_1.16.17_PM_hlzti3.png) + +--- + +## Manage Store Metadata + +Metadata is custom data that can be associated with the store in key-value pairs. This is usually used by developers for custom integrations or to store additional information about the store. + +To edit the store's metadata: + +1. Click the icon at the right of the "Metadata" section. +2. In the side window that opens: + - Manage the key-value pairs in the table. + - To add a new row of key-value pairs before or after a row: + - Hover over the row and click the icon at its right. + - Choose "Insert row above" or "Insert row below" from the dropdown. + - To delete a row of key-value pairs: + - Hover over the row and click the icon at its right. + - Choose "Delete row" from the dropdown. +3. Once you're done, click the Save button. diff --git a/www/apps/user-guide/generated/edit-dates.mjs b/www/apps/user-guide/generated/edit-dates.mjs index 6b49c18bf6..11db266f76 100644 --- a/www/apps/user-guide/generated/edit-dates.mjs +++ b/www/apps/user-guide/generated/edit-dates.mjs @@ -7,7 +7,7 @@ export const generatedEditDates = { "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/settings/page.mdx": "2025-02-19T10:57:33.537Z", "app/products/export/page.mdx": "2025-02-18T12:16:52.639Z", "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", @@ -19,7 +19,7 @@ export const generatedEditDates = { "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/settings/store/page.mdx": "2025-02-19T11:19:01.136Z", "app/products/import/page.mdx": "2025-02-18T12:15:03.830Z", "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", diff --git a/www/apps/user-guide/generated/sidebar.mjs b/www/apps/user-guide/generated/sidebar.mjs index a5b036abbb..8ff4a14c78 100644 --- a/www/apps/user-guide/generated/sidebar.mjs +++ b/www/apps/user-guide/generated/sidebar.mjs @@ -347,173 +347,117 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "category", - "path": "/settings", "title": "Settings", - "autogenerate_path": "/settings", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/profile", - "title": "Profile", - "description": "", + "title": "Overview", + "path": "/settings", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/store", "title": "Store", - "description": "", + "path": "/settings/store", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/users", "title": "Users", - "description": "", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/users/invites", - "title": "Manage Invites", - "description": "", - "children": [], - "sidebar_position": 1 - } - ] + "path": "/settings/users", + "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/regions", "title": "Regions", - "description": "", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/regions/manage", - "title": "Manage Regions", - "description": "", - "children": [], - "sidebar_position": 1 - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/regions/countries", - "title": "Manage Countries", - "description": "", - "children": [], - "sidebar_position": 2 - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/regions/providers", - "title": "Manage Providers", - "description": "", - "children": [], - "sidebar_position": 3 - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/regions/shipping-options", - "title": "Manage Shipping Options", - "description": "", - "children": [], - "sidebar_position": 4 - } - ] + "path": "/settings/regions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Tax Regions", + "path": "#", + "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/return-reasons", "title": "Return Reasons", - "description": "", + "path": "/settings/return-reasons", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/taxes", - "title": "Taxes", - "description": "", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/taxes/manage", - "title": "Manage Taxes", - "description": "", - "children": [], - "sidebar_position": 1 - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/taxes/tax-rates", - "title": "Manage Tax Rates", - "description": "", - "children": [], - "sidebar_position": 2 - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/locations", - "title": "Locations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/sales-channels", "title": "Sales Channels", - "description": "", + "path": "/settings/sales-channels", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Product Types", + "path": "#", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Product Tags", + "path": "#", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Location & Shipping", + "path": "/settings/locations", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Developer Settings", "children": [ { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/sales-channels/manage", - "title": "Manage Sales Channels", - "description": "", - "children": [], - "sidebar_position": 1 + "title": "Publishable API Keys", + "path": "#", + "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/sales-channels/products", - "title": "Manage Products", - "description": "", - "children": [], - "sidebar_position": 2 + "title": "Secret API Keys", + "path": "#", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Workflows", + "path": "/settings/executions", + "children": [] } ] }, @@ -521,42 +465,9 @@ export const generatedSidebar = [ "loaded": true, "isPathHref": true, "type": "link", - "path": "/settings/developer", - "title": "Developer", - "description": "", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/developer/api-key-management", - "title": "API Key Management", - "description": "", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/developer/api-key-management/sales-channels", - "title": "Manage Sales Channels", - "description": "", - "children": [], - "sidebar_position": 1 - } - ], - "sidebar_position": 1 - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/settings/developer/executions", - "title": "Executions", - "description": "", - "children": [], - "sidebar_position": 2 - } - ] + "title": "Profile", + "path": "/settings/profile", + "children": [] } ] } diff --git a/www/apps/user-guide/sidebar.mjs b/www/apps/user-guide/sidebar.mjs index 44ffa0e902..8a5eda3083 100644 --- a/www/apps/user-guide/sidebar.mjs +++ b/www/apps/user-guide/sidebar.mjs @@ -212,8 +212,84 @@ export const sidebar = sidebarAttachHrefCommonOptions([ }, { type: "category", - path: "/settings", title: "Settings", - autogenerate_path: "/settings", + children: [ + { + type: "link", + title: "Overview", + path: "/settings", + }, + { + type: "link", + title: "Store", + path: "/settings/store", + }, + { + type: "link", + title: "Users", + path: "/settings/users", + }, + { + type: "link", + title: "Regions", + path: "/settings/regions", + }, + { + type: "link", + title: "Tax Regions", + path: "#", + }, + { + type: "link", + title: "Return Reasons", + path: "/settings/return-reasons", + }, + { + type: "link", + title: "Sales Channels", + path: "/settings/sales-channels", + }, + { + type: "link", + title: "Product Types", + path: "#", + }, + { + type: "link", + title: "Product Tags", + path: "#", + }, + { + type: "link", + title: "Location & Shipping", + path: "/settings/locations", + }, + { + type: "category", + title: "Developer Settings", + children: [ + { + type: "link", + title: "Publishable API Keys", + path: "#", + }, + { + type: "link", + title: "Secret API Keys", + path: "#", + }, + { + type: "link", + title: "Workflows", + path: "/settings/executions", + }, + ], + }, + { + type: "link", + title: "Profile", + path: "/settings/profile", + }, + ], }, ])