diff --git a/www/apps/user-guide/app/customers/groups/page.mdx b/www/apps/user-guide/app/customers/groups/page.mdx index fa5f818dde..e40560ed69 100644 --- a/www/apps/user-guide/app/customers/groups/page.mdx +++ b/www/apps/user-guide/app/customers/groups/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 2 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Customer Groups`, + title: `Manage Customer Groups in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/customers/manage/page.mdx b/www/apps/user-guide/app/customers/manage/page.mdx index f1237b07f6..31586681c6 100644 --- a/www/apps/user-guide/app/customers/manage/page.mdx +++ b/www/apps/user-guide/app/customers/manage/page.mdx @@ -6,7 +6,7 @@ import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusa import { Table } from "docs-ui" export const metadata = { - title: `Manage Customers`, + title: `Manage Customers in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/customers/page.mdx b/www/apps/user-guide/app/customers/page.mdx index 4fa69b28ca..06a86c5c6c 100644 --- a/www/apps/user-guide/app/customers/page.mdx +++ b/www/apps/user-guide/app/customers/page.mdx @@ -3,7 +3,7 @@ sidebar_autogenerate_exclude: true --- export const metadata = { - title: `Customers Overview`, + title: `Customers Overview in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/inventory/inventory/page.mdx b/www/apps/user-guide/app/inventory/inventory/page.mdx index 7e3db37c3e..76012b876e 100644 --- a/www/apps/user-guide/app/inventory/inventory/page.mdx +++ b/www/apps/user-guide/app/inventory/inventory/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Inventory Items`, + title: `Manage Inventory Items in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/inventory/page.mdx b/www/apps/user-guide/app/inventory/page.mdx index c33ab6b2ea..3b55b90812 100644 --- a/www/apps/user-guide/app/inventory/page.mdx +++ b/www/apps/user-guide/app/inventory/page.mdx @@ -3,7 +3,7 @@ sidebar_autogenerate_exclude: true --- export const metadata = { - title: `Inventory Overview`, + title: `Inventory Overview in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/inventory/reservations/page.mdx b/www/apps/user-guide/app/inventory/reservations/page.mdx index 14cfdaffc5..df23f83a20 100644 --- a/www/apps/user-guide/app/inventory/reservations/page.mdx +++ b/www/apps/user-guide/app/inventory/reservations/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 3 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Reservations`, + title: `Manage Reservations in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/not-found.mdx b/www/apps/user-guide/app/not-found.mdx index bc4143fb6d..f08657c2ca 100644 --- a/www/apps/user-guide/app/not-found.mdx +++ b/www/apps/user-guide/app/not-found.mdx @@ -7,7 +7,7 @@ import { } from "@medusajs/icons" export const metadata = { - title: `Page Not Found`, + title: `Page Not Found in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/orders/claims/page.mdx b/www/apps/user-guide/app/orders/claims/page.mdx index 710b1bc64b..8b2f83643b 100644 --- a/www/apps/user-guide/app/orders/claims/page.mdx +++ b/www/apps/user-guide/app/orders/claims/page.mdx @@ -8,7 +8,7 @@ import { } from "@medusajs/icons" export const metadata = { - title: `Manage Order Claims`, + title: `Manage Order Claims in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/orders/edit/page.mdx b/www/apps/user-guide/app/orders/edit/page.mdx index 9900dc9b9a..9834015e4c 100644 --- a/www/apps/user-guide/app/orders/edit/page.mdx +++ b/www/apps/user-guide/app/orders/edit/page.mdx @@ -7,7 +7,7 @@ import { } from "@medusajs/icons" export const metadata = { - title: `Edit an Order’s Items`, + title: `Edit an Order’s Items in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/orders/exchanges/page.mdx b/www/apps/user-guide/app/orders/exchanges/page.mdx index 9f2017755d..30ba5e0cd2 100644 --- a/www/apps/user-guide/app/orders/exchanges/page.mdx +++ b/www/apps/user-guide/app/orders/exchanges/page.mdx @@ -8,7 +8,7 @@ import { } from "@medusajs/icons" export const metadata = { - title: `Manage Exchanges`, + title: `Manage Exchanges in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/orders/fulfillments/page.mdx b/www/apps/user-guide/app/orders/fulfillments/page.mdx index d03f7a4293..47de0b0aec 100644 --- a/www/apps/user-guide/app/orders/fulfillments/page.mdx +++ b/www/apps/user-guide/app/orders/fulfillments/page.mdx @@ -9,7 +9,7 @@ import { import { Table } from "docs-ui" export const metadata = { - title: `Manage Order Fulfillments`, + title: `Manage Order Fulfillments in Medusa Admin`, } # {metadata.title} @@ -62,11 +62,11 @@ At the top of the order details page, you can see the fulfillment status of the Partially Delivered - Some items in the order have been marked as delivered, but not all. + Some items in the order have been marked as delivered or picked-up, but not all. Delivered - All items in the order have been marked as delivered. + All items in the order have been marked as delivered or picked-up. Partially Returned @@ -114,6 +114,12 @@ This can also change the order's fulfillment status to "Partially Fulfilled" or ## Add a Shipment to a Fulfillment + + +You can only add a shipment to a fulfillment if its shipping option isn't a pickup option. + + + After you create a fulfillment, you can add a shipment to it. A shipment can have a tracking number and marks the fulfillment as shipped. @@ -140,6 +146,12 @@ This changes the order's fulfillment status to "Partially Shipped" or "Shipped" ## Mark Fulfillment as Delivered + + +You can only mark a fulfillment as delivered if its shipping option isn't a pickup option. + + + You can mark a fulfillment as delivered, even if it hasn't been shipped. This can be useful if you deliver items to the customer using external methods. @@ -153,7 +165,7 @@ To mark the fulfillment as delivered: 1. Open the order's details page. 2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for. 3. Click on the "Mark as delivered" button at the bottom right of the section. -4. Confirm marking the order as delivered by clicking the "Continue" button in the pop-up +4. Confirm marking the fulfillment as delivered by clicking the "Continue" button in the pop-up ![Mark as Delivered Pop-up](https://res.cloudinary.com/dza7lstvk/image/upload/v1739784298/User%20Guide/Screenshot_2025-02-17_at_11.24.48_AM_dpplxp.png) @@ -161,6 +173,29 @@ This changes the order's fulfillment status to "Partially Delivered" or "Deliver --- +## Mark Fulfillment as Picked Up + +If the fulfillment's shipping option is a pickup option, you can mark the fulfillment as picked up. This can be useful if the customer picks up the items in person. + + + +Marking a fulfillment as picked up is irreversible. You can't cancel the fulfillment or the order afterwards. + + + +To mark the fulfillment as picked up: + +1. Open the order's details page. +2. Scroll down to the Fulfillment section. If you have more than one fulfillment, find the fulfillment you're looking for. +3. Click on the "Mark as picked up" button at the bottom right of the section. +4. Confirm marking the fulfillment as picked up by clicking the "Continue" button in the pop-up. + +![Mark as Picked Up Pop-up](https://res.cloudinary.com/dza7lstvk/image/upload/v1740486580/User%20Guide/Screenshot_2025-02-25_at_2.28.36_PM_ncci0m.png) + +This changes the order's fulfillment status to "Partially Delivered" or "Delivered" depending on the items picked up. + +--- + ## Cancel a Fulfillment You can cancel a fulfillment if you haven't shipped or marked it as delivered yet. This can be useful if you need to change the items fulfilled or if the customer cancels the order. diff --git a/www/apps/user-guide/app/orders/manage/page.mdx b/www/apps/user-guide/app/orders/manage/page.mdx index 52a3f12b2a..24e6af92f1 100644 --- a/www/apps/user-guide/app/orders/manage/page.mdx +++ b/www/apps/user-guide/app/orders/manage/page.mdx @@ -11,7 +11,7 @@ import { } from "@medusajs/icons" export const metadata = { - title: `Manage Order Details`, + title: `Manage Order Details in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/orders/page.mdx b/www/apps/user-guide/app/orders/page.mdx index 31b51be90a..ab22cc4129 100644 --- a/www/apps/user-guide/app/orders/page.mdx +++ b/www/apps/user-guide/app/orders/page.mdx @@ -3,7 +3,7 @@ sidebar_autogenerate_exclude: true --- export const metadata = { - title: `Orders Overview`, + title: `Orders Overview in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/orders/payments/page.mdx b/www/apps/user-guide/app/orders/payments/page.mdx index 673861743c..5d6699d627 100644 --- a/www/apps/user-guide/app/orders/payments/page.mdx +++ b/www/apps/user-guide/app/orders/payments/page.mdx @@ -9,7 +9,7 @@ import { import { Table } from "docs-ui" export const metadata = { - title: `Manage Order Payments`, + title: `Manage Order Payments in Medusa Admin`, } # {metadata.title} @@ -148,8 +148,6 @@ The link is then copied and you can share it with the customer to authorize the -{/* TODO add link to guide once available */} - -If the payment link doesn't start with a domain or has a domain that doesn't match your storefront, refer your technical team to [this guide](#) to set up the storefront domain. +If the payment link doesn't start with a domain or has a domain that doesn't match your storefront, refer your technical team to [this guide](!resources!/references/medusa-config#storefronturl) to set up the storefront domain. diff --git a/www/apps/user-guide/app/orders/returns/page.mdx b/www/apps/user-guide/app/orders/returns/page.mdx index f06a6b3309..f4fc4b8c2c 100644 --- a/www/apps/user-guide/app/orders/returns/page.mdx +++ b/www/apps/user-guide/app/orders/returns/page.mdx @@ -10,7 +10,7 @@ import { } from "@medusajs/icons" export const metadata = { - title: `Manage Order Returns`, + title: `Manage Order Returns in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/page.mdx b/www/apps/user-guide/app/page.mdx index d16df61544..fff3ae407c 100644 --- a/www/apps/user-guide/app/page.mdx +++ b/www/apps/user-guide/app/page.mdx @@ -1,15 +1,13 @@ import { BellAlert, SidebarLeft } from "@medusajs/icons" export const metadata = { - title: `Medusa Admin User Guide`, + title: `Medusa Admin User Guide in Medusa Admin`, } # {metadata.title} 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 update photo */} - ![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? @@ -95,6 +93,4 @@ Learn how to change the language in [this guide](./settings/profile/page.mdx#cha 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 add dark theme */} - ![Dark Theme](https://res.cloudinary.com/dza7lstvk/image/upload/v1739530936/User%20Guide/Screenshot_2025-02-14_at_1.01.56_PM_fdcgmz.png) diff --git a/www/apps/user-guide/app/price-lists/create/page.mdx b/www/apps/user-guide/app/price-lists/create/page.mdx index 5e2a7a11d5..9c894e5067 100644 --- a/www/apps/user-guide/app/price-lists/create/page.mdx +++ b/www/apps/user-guide/app/price-lists/create/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 import { EllipsisHorizontal } from "@medusajs/icons" export const metadata = { - title: `Create a Price List`, + title: `Create a Price List in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/price-lists/manage/page.mdx b/www/apps/user-guide/app/price-lists/manage/page.mdx index 94911461ed..36c3b6bb67 100644 --- a/www/apps/user-guide/app/price-lists/manage/page.mdx +++ b/www/apps/user-guide/app/price-lists/manage/page.mdx @@ -6,7 +6,7 @@ import { EllipsisHorizontal } from "@medusajs/icons" import { Table } from "docs-ui" export const metadata = { - title: `Manage Price Lists`, + title: `Manage Price Lists in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/price-lists/page.mdx b/www/apps/user-guide/app/price-lists/page.mdx index b83409cb9c..6c0d587aac 100644 --- a/www/apps/user-guide/app/price-lists/page.mdx +++ b/www/apps/user-guide/app/price-lists/page.mdx @@ -3,7 +3,7 @@ sidebar_autogenerate_exclude: true --- export const metadata = { - title: `Price Lists`, + title: `Price Lists in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/categories/page.mdx b/www/apps/user-guide/app/products/categories/page.mdx index ea982a8209..8097280755 100644 --- a/www/apps/user-guide/app/products/categories/page.mdx +++ b/www/apps/user-guide/app/products/categories/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 5 import { DotsSix, TriangleRightMini, EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Product Categories`, + title: `Manage Product Categories in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/collections/page.mdx b/www/apps/user-guide/app/products/collections/page.mdx index da907d6074..8441ad499e 100644 --- a/www/apps/user-guide/app/products/collections/page.mdx +++ b/www/apps/user-guide/app/products/collections/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 import { EllipsisHorizontal,ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Product Collections`, + title: `Manage Product Collections in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/create/bundle/page.mdx b/www/apps/user-guide/app/products/create/bundle/page.mdx index ca7e29ee29..2a07f4689a 100644 --- a/www/apps/user-guide/app/products/create/bundle/page.mdx +++ b/www/apps/user-guide/app/products/create/bundle/page.mdx @@ -3,7 +3,7 @@ sidebar_label: "Bundle Product" --- export const metadata = { - title: `Create Bundle Product`, + title: `Create Bundle Product in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/create/multi-part/page.mdx b/www/apps/user-guide/app/products/create/multi-part/page.mdx index 75fb1486fc..7da0f9d400 100644 --- a/www/apps/user-guide/app/products/create/multi-part/page.mdx +++ b/www/apps/user-guide/app/products/create/multi-part/page.mdx @@ -3,7 +3,7 @@ sidebar_label: "Multi-Part Product" --- export const metadata = { - title: `Create Multi-Part Product`, + title: `Create Multi-Part Product in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/create/page.mdx b/www/apps/user-guide/app/products/create/page.mdx index 9e26194721..3c04dbc533 100644 --- a/www/apps/user-guide/app/products/create/page.mdx +++ b/www/apps/user-guide/app/products/create/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 import { DotsSix, EllipsisHorizontal, XMark, TaxExclusive, TaxInclusive } from "@medusajs/icons" export const metadata = { - title: `Create Product`, + title: `Create Product in Medusa Admin`, } # {metadata.title} @@ -58,14 +58,12 @@ Once you're done, click the "Continue" button. In the second "Organize" step, you can organize the product by adding it to collections, categories, and other organization details: -{/* TODO add links later */} - 1. If you don't want to allow applying discounts to the product, disable the "Discountable" toggle. -2. You can optionally choose a type for the products. You can create product types in [Settings](#). +2. You can optionally choose a type for the products. You can create product types in [Settings](../../settings/product-types/page.mdx). 3. You can optionally choose a collection for the product. You can create collections under the [Product domain](../collections/page.mdx). 4. You can optionally choose categories for the product. You can create categories under the [Product domain](../categories/page.mdx). -5. You can optionally add tags to the product. You can create product tags in [Settings](#). -6. You must enter a shipping profile for the product. A shipping profile defines how a product can be shipped. You can create shipping profiles in [Settings](#). +5. You can optionally add tags to the product. You can create product tags in [Settings](../../settings/product-tags/page.mdx). +6. You can optionally choose a shipping profile for the product. A shipping profile defines how a product can be shipped. You can create shipping profiles in [Settings](../../settings/locations-and-shipping/shipping-profiles/page.mdx). 7. You can optionally set the sales channels a product is available in. In the storefront, only the products that are in the storefront's sales channel can be purchased. To add the product to a sales channel: - Click the "Add" button next to the "Sales channels" section. - In the list that opens, check the sales channels you want to add the product to. diff --git a/www/apps/user-guide/app/products/edit/page.mdx b/www/apps/user-guide/app/products/edit/page.mdx index 77a538ed3d..b97b6a52bc 100644 --- a/www/apps/user-guide/app/products/edit/page.mdx +++ b/www/apps/user-guide/app/products/edit/page.mdx @@ -6,7 +6,7 @@ import { ArrowUpRightOnBox, EllipsisHorizontal, EllipsisVertical, ThumbnailBadge import { Table } from "docs-ui" export const metadata = { - title: `Edit Product`, + title: `Edit Product in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/export/page.mdx b/www/apps/user-guide/app/products/export/page.mdx index dec966dc4e..68b14014a7 100644 --- a/www/apps/user-guide/app/products/export/page.mdx +++ b/www/apps/user-guide/app/products/export/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 7 import { BellAlert, ArrowDownTray } from "@medusajs/icons" export const metadata = { - title: `Export Products`, + title: `Export Products in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/import/page.mdx b/www/apps/user-guide/app/products/import/page.mdx index 354d5ae8d9..b8153a6851 100644 --- a/www/apps/user-guide/app/products/import/page.mdx +++ b/www/apps/user-guide/app/products/import/page.mdx @@ -6,7 +6,7 @@ import { ArrowDownTray, Trash, BellAlert, EllipsisHorizontal } from "@medusajs/i import { Prerequisites, Table } from "docs-ui" export const metadata = { - title: `Import Products`, + title: `Import Products in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/products/page.mdx b/www/apps/user-guide/app/products/page.mdx index b20ea10705..4fba96c2da 100644 --- a/www/apps/user-guide/app/products/page.mdx +++ b/www/apps/user-guide/app/products/page.mdx @@ -1,5 +1,5 @@ export const metadata = { - title: `Products Overview`, + title: `Products Overview in Medusa Admin`, } # {metadata.title} @@ -32,7 +32,5 @@ Find tips to use lists effectively in [this guide](../tips/lists/page.mdx). You can also manage other product-related data under Settings: -{/* TODO add links */} - -- [Manage Product Tags](#) -- [Manage Product Types](#) \ No newline at end of file +- [Manage Product Tags](../settings/product-tags/page.mdx) +- [Manage Product Types](../settings/product-types/page.mdx) diff --git a/www/apps/user-guide/app/products/variants/page.mdx b/www/apps/user-guide/app/products/variants/page.mdx index 0cc47987bf..1e38a5c8ab 100644 --- a/www/apps/user-guide/app/products/variants/page.mdx +++ b/www/apps/user-guide/app/products/variants/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 3 import { EllipsisVertical, TaxExclusive, TaxInclusive, ArrowUpRightOnBox } from "@medusajs/icons" export const metadata = { - title: `Manage Product Variants`, + title: `Manage Product Variants in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/promotions/campaigns/page.mdx b/www/apps/user-guide/app/promotions/campaigns/page.mdx index 81f4165a5f..1aee548ac0 100644 --- a/www/apps/user-guide/app/promotions/campaigns/page.mdx +++ b/www/apps/user-guide/app/promotions/campaigns/page.mdx @@ -2,7 +2,7 @@ import { EllipsisHorizontal } from "@medusajs/icons" import { Table } from "docs-ui" export const metadata = { - title: `Manage Campaigns`, + title: `Manage Campaigns in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/promotions/create/page.mdx b/www/apps/user-guide/app/promotions/create/page.mdx index fec23a2279..0d0c96d675 100644 --- a/www/apps/user-guide/app/promotions/create/page.mdx +++ b/www/apps/user-guide/app/promotions/create/page.mdx @@ -3,7 +3,7 @@ sidebar_position: 1 --- export const metadata = { - title: `Create a Promotion`, + title: `Create a Promotion in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/promotions/manage/page.mdx b/www/apps/user-guide/app/promotions/manage/page.mdx index 1f313b061d..c7396e0303 100644 --- a/www/apps/user-guide/app/promotions/manage/page.mdx +++ b/www/apps/user-guide/app/promotions/manage/page.mdx @@ -6,7 +6,7 @@ import { EllipsisHorizontal } from "@medusajs/icons" import { Table } from "docs-ui" export const metadata = { - title: `Manage Promotions`, + title: `Manage Promotions in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/promotions/page.mdx b/www/apps/user-guide/app/promotions/page.mdx index eb6ba9e9b4..e942e3b97e 100644 --- a/www/apps/user-guide/app/promotions/page.mdx +++ b/www/apps/user-guide/app/promotions/page.mdx @@ -3,7 +3,7 @@ sidebar_autogenerate_exclude: true --- export const metadata = { - title: `Promotions`, + title: `Promotions in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/developer/api-key-management/page.mdx b/www/apps/user-guide/app/settings/developer/api-key-management/page.mdx deleted file mode 100644 index 32dee9cf89..0000000000 --- a/www/apps/user-guide/app/settings/developer/api-key-management/page.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -sidebar_position: 1 ---- - -import { SquareTwoStack, EllipsisHorizontal } from "@medusajs/icons" - -export const metadata = { - title: `API Key Management`, -} - -# {metadata.title} - -In this document, you’ll learn how to manage publishable API keys in the Medusa Admin. - -## What is a Publishable API Key - -Publishable API key define resources associated with a public API key. This API key is used by developers when developing a storefront. - -Currently, publishable API keys are only associated with sales channels. - ---- - -## Create a Publishable API Key - -To create a publishable API key: - -1. Go to Settings → API key management. -2. Click on the Create button at the top right. -3. In the new form that opens, enter the title of the API key. -4. Click the Save button. - ---- - -## Copy Token of Publishable API Key - -To copy the token of an API key: - -1. Go to Settings → API key management. -2. Find the API key you want to copy. -3. Click the icon in the Key column of the API key. - ---- - -## Edit Publishable API Key Details - -To edit the details of an API key: - -1. Go to Settings → API key management. -2. Find the publishable API key in the list and click on it. -3. Click the icon at the top right of the first section. -4. Choose Edit from the dropdown. -5. In the drawer that opens, edit the publishable API key's details. -6. Once you're done, click the Save button. - ---- - -## Revoke Publishable API Key - - - -Revoking a publishable API key is irreversible. - - - -To revoke a publishable API key: - -1. Go to Settings → API key management. -2. Find the publishable API key in the list and click on it. -3. Click the icon at the top right of the first section. -4. Choose Revoke from the dropdown. -5. Confirm revoking the publishable API key by clicking the Revoke button in the pop-up. - ---- - -## Delete Publishable API Key - - - -Deleting a publishable API key is irreversible. - - - -To delete a publishable API key: - -1. Go to Settings → API key management. -2. Find the publishable API key in the list and click on it. -3. Click the icon at the top right of the first section. -4. Choose Delete from the dropdown. -5. Confirm deleting the publishable API key by clicking the Delete button in the pop-up. \ No newline at end of file diff --git a/www/apps/user-guide/app/settings/developer/api-key-management/sales-channels/page.mdx b/www/apps/user-guide/app/settings/developer/api-key-management/sales-channels/page.mdx deleted file mode 100644 index 3bb1ce85fa..0000000000 --- a/www/apps/user-guide/app/settings/developer/api-key-management/sales-channels/page.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 1 -sidebar_label: "Manage Sales Channels" ---- - -export const metadata = { - title: `Manage Sales Channels of a Publishable API Key`, -} - -# {metadata.title} - -In this document, you'll learn how to manage the sales channels of a publishable API key. - -## Add Sales Channels - -To add sales channels to a publishable API key: - -1. Go to Settings → API key management. -2. Find the publishable API key in the list and click on it. -3. Under the Sales Channels section, click the Add button. -4. In the list that opens, check the checkbox next the sales channels to add. -5. Once you're done, click the Save button. - ---- - -## Remove Sales Channels - -To remove sales channels from a publishable API key: - -1. Go to Settings → API key management. -2. Find the publishable API key in the list and click on it. -3. Under the Sales Channels section, check the checkbox next to the sales channels you want to remove. -4. Once you're done, press R -5. Confirm deleting the sales channel by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/developer/executions/page.mdx b/www/apps/user-guide/app/settings/developer/executions/page.mdx deleted file mode 100644 index 8ccc58ec83..0000000000 --- a/www/apps/user-guide/app/settings/developer/executions/page.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 -sidebar_label: "Executions" ---- - -import { ArrowsPointingOut } from "@medusajs/icons" - -export const metadata = { - title: `View Executions`, -} - -# {metadata.title} - -In this documentation, you'll learn how to view executions in your store and their details. - -## What is an Execution? - -An execution refers to a workflow that's been executed. You can view a workflow execution's progress, details, and raw JSON data all from the Medusa Admin. - ---- - -## View Executions - -To view all workflow executions, go to Settings → Executions. You'll find a list of executions with general details. - ---- - -## View Execution Details - -To view an execution's details: - -1. Go to Settings → Executions. -2. Click on the execution to view it. - -On the execution's page, you'll find multiple sections with the execution's details. - -### Summary Section - -In the first section, you'll find a summary of the execution, including its status, workflow ID, transaction ID, and progress. - -### Timeline - -The timeline diagram shows you the execution step by step. You can zoom in and pan to view the entire diagram. - -If you click on a step, you'll be shown the details in the History section. - -### History - -The History section shows you the execution of the steps in a linear path. - -If you click on a step, you'll see its definition, output, and compensation input. - -For a failed step, you'll see the error that occurred. - -### JSON - -The JSON section allows you to see view the execution's details as a raw JSON by clicking the icon. diff --git a/www/apps/user-guide/app/settings/developer/page.mdx b/www/apps/user-guide/app/settings/developer/page.mdx index 42dde7743f..7bbfa2d8a3 100644 --- a/www/apps/user-guide/app/settings/developer/page.mdx +++ b/www/apps/user-guide/app/settings/developer/page.mdx @@ -4,16 +4,15 @@ sidebar_label: "Developer" --- export const metadata = { - title: `Developer Settings`, + title: `Developer Settings in Medusa Admin`, } # {metadata.title} -The Developer section in the settings allows you to manage developer-related settings, such as API key managements or executions. +The Developer section in the Medusa Admin's settings is useful for developers building customizations for your Medusa application. If you're unsure about how to use these settings, please consult with your technical team. ---- +## Manage Developer Settings -## Learn More about Developer Settings - -- [API Key Management](./api-key-management/page.mdx) -- [Executions](./executions/page.mdx) +- [Publishable API Keys Management](./publishable-api-keys/page.mdx) +- [Secret API Keys Management](./secret-api-keys/page.mdx) +- [View Workflow Executions](./workflows/page.mdx) diff --git a/www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx b/www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx new file mode 100644 index 0000000000..1134bff776 --- /dev/null +++ b/www/apps/user-guide/app/settings/developer/publishable-api-keys/page.mdx @@ -0,0 +1,168 @@ +import { Table } from "docs-ui" +import { EllipsisHorizontal } from "@medusajs/icons" + +export const metadata = { + title: `Manage Publishable API Keys in Medusa Admin`, +} + +# {metadata.title} + +In this guide, you'll learn how to create and manage publishable API keys in the Medusa Admin. + + + +This guide is mainly useful for developers and technical teams building customizations for a Medusa application. + + + +## What is a Publishable API Key? + +A publishable API key is a client key scoped to one or more sales channels. When you build a storefront, you must pass a publishable API key in the request headers indicating the sales channel to scope the request to. This impacts the products retrieved, available stock quantities, and other data. + +To learn how to pass the publishable API key in request headers, refer to the [API Reference](!api!/store#publishable-api-key). + +--- + +## View Publishable API Keys + +To view the publishable API keys in the Medusa Admin, go to Settings -> Publishable API Keys. + +Here, you can see a list of all the publishable API keys you have set up in your store. You can also search, filter, and sort the API keys to find the one you are looking for. + +![Publishable API keys list](https://res.cloudinary.com/dza7lstvk/image/upload/v1740489989/User%20Guide/Screenshot_2025-02-25_at_3.26.09_PM_xmpxdw.png) + +--- + +## Create Publishable API Key + +To create a new publishable API key: + +1. Go to Settings -> Publishable API Keys. +2. Click the Create button at the top right. +3. In the form that opens, enter the publishable API key's title. +4. Once you're done, click the Save button. + +![Create publishable API key form](https://res.cloudinary.com/dza7lstvk/image/upload/v1740490166/User%20Guide/Screenshot_2025-02-25_at_3.28.44_PM_aosbhw.png) + +--- + +## View Publishable API Key Details + +To view the details of a publishable API key: + +1. Go to Settings -> Publishable API Keys. +2. Click on a publishable API key from the list. + +This opens the publishable API key's details page where you can also manage the API key. + +![Publishable API key details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1740490244/User%20Guide/Screenshot_2025-02-25_at_3.30.35_PM_bgcl23.png) + +### Publishable API Key Status + +You can see the status of the publishable API key at the top right of the first section in the details page. A publishable API key's status can be: + + + + + Status + Description + + + + + Active + The API key is active and can be used in requests. + + + Revoked + The API key has been revoked and can't be used in requests. + + +
+ +--- + +## Copy Publishable API Key + +To copy a publishable API key: + +1. Go to the publishable API key's details page. +2. In the first section, click on the truncated key to copy it to your clipboard. + +![Copy publishable API key](https://res.cloudinary.com/dza7lstvk/image/upload/v1740500116/User%20Guide/Screenshot_2025-02-25_at_6.14.15_PM_muwq9e.png) + +--- + +## Edit Publishable API Key + +To edit a publishable API key: + +1. Go to the publishable API key's details page. +2. Click the at the top right of the first section. +3. Choose "Edit" from the dropdown. +4. In the side window that opens, you can edit the publishable API key's title. +5. Once you're done, click the Save button. + +![Edit publishable API key form](https://res.cloudinary.com/dza7lstvk/image/upload/v1740490481/User%20Guide/Screenshot_2025-02-25_at_3.34.28_PM_hxppxj.png) + +--- + +## Manage Publishable API Key's Sales Channels + +You can manage the sales channels of a publishable API key in its details page. By adding sales channels to the publishable API key, it becomes part of the scope in requests made with the key. + +### Add Sales Channels + +To add a sales channel to a publishable API key: + +1. Go to the publishable API key's details page. +2. Click the "Add" button at the top right of the "Sales Channels" section. +3. In the list that opens, check the sales channels you want to add the API key to. +4. Once you're done, click the Save button. + +![Add sales channels form](https://res.cloudinary.com/dza7lstvk/image/upload/v1740490636/User%20Guide/Screenshot_2025-02-25_at_3.37.05_PM_ontnzy.png) + +### Remove Sales Channels + +To remove a sales channel from a publishable API key: + +1. Go to the publishable API key's details page. +2. Check the checkbox next to the sales channel you want to remove in the "Sales Channels" section. +3. Press R or click the Remove button at the bottom center of the page. +4. Confirm removing the sales channels by clicking the Continue button. + +![Remove sales channels from publishable API key](https://res.cloudinary.com/dza7lstvk/image/upload/v1740490931/User%20Guide/Screenshot_2025-02-25_at_3.38.41_PM_pmlbqk.png) + +--- + +## Revoke Publishable API Key + + + +Revoking a publishable API key is irreversible. You can't use the key in requests after revoking it or reactivate it. + + + +To revoke a publishable API key: + +1. Go to the publishable API key's details page. +2. Click the at the top right of the first section. +3. Choose "Revoke API key" from the dropdown. +4. Confirm revoking the API key by clicking the "Revoke API key" button in the pop-up. + +--- + +## Delete Publishable API Key + + + +Deleting a publishable API key is irreversible. + + + +You can only delete a publishable API key after [revoking it](#revoke-publishable-api-key). To delete a publishable API key: + +1. Go to the publishable API key's details page. +2. Click the at the top right of the first section. +3. Choose "Delete" from the dropdown. +4. Confirm deleting the API key by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx b/www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx new file mode 100644 index 0000000000..c36c56019e --- /dev/null +++ b/www/apps/user-guide/app/settings/developer/secret-api-keys/page.mdx @@ -0,0 +1,132 @@ +import { Table } from "docs-ui" +import { EllipsisHorizontal } from "@medusajs/icons" + +export const metadata = { + title: `Manage Secret API Keys in Medusa Admin`, +} + +# {metadata.title} + +In this guide, you'll learn how to create and manage secret API keys in the Medusa Admin. + + + +This guide is mainly useful for developers and technical teams building customizations for a Medusa application. + + + +## What is a Secret API Key? + +A secret API key is an authentication token that allows you to access Medusa's Admin APIs. You can pass it in request headers to send requests as an authenticated admin user. So, it's important to not expose the secret API key in client-side code or public repositories. + +To learn how to pass the secret API key in request headers, refer to the [API Reference](!api!/admin#2-api-token). + +--- + +## View Secret API Keys + +To view the secret API keys of the currently logged-in user in the Medusa Admin, go to Settings -> Secret API Keys. + +Here, you can see a list of all the secret API keys for the logged-in user. You can also search, filter, and sort the API keys to find the one you are looking for. + +![Secret API keys list](https://res.cloudinary.com/dza7lstvk/image/upload/v1740491442/User%20Guide/Screenshot_2025-02-25_at_3.49.04_PM_asthgc.png) + +--- + +## Create Secret API Key + +When you create a secret API key, you create it for the currently logged-in user. A user can have one active secret key at a time. So, if you already have one, you must [revoke it](#revoke-secret-api-key) before creating a new one. + +To create a new secret API key for the currently logged-in user: + +1. Go to Settings -> Secret API Keys. +2. Click the Create button at the top right. +3. In the form that opens, enter the secret API key's title. +4. Once you're done, click the Save button. +5. You'll get a pop-up with the secret API key. Copy it and store it securely before closing the pop-up, as you won't be able to see it again. + +![Create secret API key form](https://res.cloudinary.com/dza7lstvk/image/upload/v1740495860/User%20Guide/Screenshot_2025-02-25_at_5.04.07_PM_u91vm5.png) + +--- + +## View Secret API Key Details + +To view the details of a secret API key: + +1. Go to Settings -> Secret API Keys. +2. Click on a secret API key from the list. + +This opens the secret API key's details page where you can also manage the API key. + +![Secret API key details page](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496080/User%20Guide/Screenshot_2025-02-25_at_5.07.49_PM_oqt9mf.png) + +### Secret API Key Status + +You can see the status of the secret API key at the top right of the first section in the details page. A secret API key's status can be: + + + + + Status + Description + + + + + Active + The API key is active and can be used in requests. + + + Revoked + The API key has been revoked and can't be used in requests. + + +
+ +--- + +## Edit Secret API Key + +To edit a secret API key: + +1. Go to the secret API key's details page. +2. Click the at the top right of the first section. +3. Choose "Edit" from the dropdown. +4. In the side window that opens, you can edit the secret API key's title. +5. Once you're done, click the Save button. + +![Edit secret API key form](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496144/User%20Guide/Screenshot_2025-02-25_at_5.08.53_PM_o4h3cn.png) + +--- + +## Revoke Secret API Key + + + +Revoking a secret API key is irreversible. You can't use the key in requests after revoking it or reactivate it. + + + +To revoke a secret API key: + +1. Go to the secret API key's details page. +2. Click the at the top right of the first section. +3. Choose "Revoke API key" from the dropdown. +4. Confirm revoking the API key by clicking the "Revoke API key" button in the pop-up. + +--- + +## Delete Secret API Key + + + +Deleting a secret API key is irreversible. + + + +You can only delete a secret API key after [revoking it](#revoke-secret-api-key). To delete a secret API key: + +1. Go to the secret API key's details page. +2. Click the at the top right of the first section. +3. Choose "Delete" from the dropdown. +4. Confirm deleting the API key by clicking the Delete button in the pop-up. diff --git a/www/apps/user-guide/app/settings/developer/workflows/page.mdx b/www/apps/user-guide/app/settings/developer/workflows/page.mdx new file mode 100644 index 0000000000..690234823b --- /dev/null +++ b/www/apps/user-guide/app/settings/developer/workflows/page.mdx @@ -0,0 +1,164 @@ +--- +sidebar_position: 2 +sidebar_label: "Executions" +--- + +import { EllipsisHorizontal, ArrowUpRightOnBox } from "@medusajs/icons" +import { Table } from "docs-ui" + +export const metadata = { + title: `View Workflow Executions in Medusa Admin`, +} + +# {metadata.title} + +In this guide, you'll learn how to view workflow executions in the Medusa Admin. + + + +This guide is mainly useful for developers and technical teams building and debugging customizations of a Medusa application. + + + +## What are Workflow Executions? + +[Workflows](!docs!/learn/fundamentals/workflows) are a series of steps that perform a task. You build a workflow in your source code to implement custom commerce flows and features. + +When you execute a workflow, it runs the steps in sequence to complete the task. If you've configured the workflow to have its executions stored in the database as explained in [this technical guide](!docs!/learn/fundamentals/workflows/store-executions), you can view the executions and their details in the Medusa Admin. This is useful to debug workflows and ensure they ran as expected. + +--- + +## View Workflow Executions + +To view workflow executions, go to Settings → Workflows. There, you'll find the list of custom and Medusa workflows that have been executed and are stored in the database. You can search through the list to find the one you're looking for. + +![Workflow executions list](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496862/User%20Guide/Screenshot_2025-02-25_at_5.16.30_PM_fjkbrc.png) + +### Workflow Execution Status + +In the list, you can view the status of each workflow execution. A workflow's execution status can be: + + + + + Status + Description + + + + + Not Started + The workflow has been executed, but its steps haven't been invoked yet. + + + Invoking + The workflow execution is currently running, invoking its steps. + + + Done + The workflow execution has finished successfully. + + + Failed + The workflow execution has failed. + + + Compensating + The workflow execution is compensating its steps after a failure. + + + Reverted + The workflow execution has been reverted, which occurs when the workflow ran as part of another workflow and the parent workflow failed. + + +
+ +--- + +## View Workflow Execution Details + +To view a workflow execution's details: + +1. Go to Settings → Workflows. +2. Click on the workflow execution to view it. + +On the workflow execution's page, you'll find multiple sections with the execution's details. + +![Workflow executions details](https://res.cloudinary.com/dza7lstvk/image/upload/v1740496967/User%20Guide/Screenshot_2025-02-25_at_5.22.33_PM_z6al6a.png) + +### Summary Section + +In the first section, you'll find a summary of the workflow execution, including: + +- A badge at the top right indicating its [status](#workflow-execution-status). +- The workflow's unique ID, which you specify when you create the workflow. +- The transaction ID, which is a unique identifier for the workflow execution. This is useful for debugging, tracking, and changing step statuses of [long-running workflows](!docs!/learn/fundamentals/workflows/long-running-workflow). +- The workflow's progress which shows a quick overview of the steps that have been executed. + +### Timeline + +The timeline diagram shows you the step by step execution of the workflow. You can zoom in and out, and drag and move the mouse to view the entire diagram. You can also click on a step to view its execution details in the [History](#history) section. + +#### Step Status + +In the timeline diagram, each step node has a small box at its left whose color indicates its status: + + + + + Color + Description + + + + + + Orange + + + The step is currently being executed. + + + + + Green + + + The step has been executed successfully. + + + + + Red + + + The step has failed. + + + + + Gray + + + The step hasn't been executed yet, or it's been skipped, which can occur if the step is part of a [when condition](!docs!/learn/fundamentals/workflows/conditions). + + + +
+ +### JSON + +The JSON section allows you to view the execution's details as a raw JSON object by clicking the icon. This is useful for advanced debugging to see all the details of the workflow execution. + +### History + +The History section shows you the execution of the workflow's steps by order of execution. You can see each step's name with a dot reflecting its status as explained in the [Step Status](#step-status) section. + +If you click on any executed step, you'll see its details, including: + +- **Definition**: the step's configurations which can be passed when you create the step. For example, the step's name, whether it has a compensation function, whether it's asynchronous, etc... +- **Output**: the step's output, which is the result of the step's execution. +- **Compensation Input**: if the workflow failed and the step has a compensation function, you can see the input that the compensation function received. +- **Error**: if the step failed, you can see the error message. + +![Workflow executions history](https://res.cloudinary.com/dza7lstvk/image/upload/v1740498395/User%20Guide/Screenshot_2025-02-25_at_5.46.20_PM_spnh0j.png) diff --git a/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx b/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx index 37b2fd3f18..60720b5632 100644 --- a/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx +++ b/www/apps/user-guide/app/settings/locations-and-shipping/locations/page.mdx @@ -6,7 +6,7 @@ sidebar_label: "Locations" import { EllipsisHorizontal, TaxExclusive, TaxInclusive } from "@medusajs/icons" export const metadata = { - title: `Manage Locations`, + title: `Manage Locations in Medusa Admin`, } # {metadata.title} @@ -110,9 +110,9 @@ To create a shipping option: 1. Go to the location's details page. 2. In the "Pickup" or "Shipping" section, find the service zone you want to add the shipping option to. -3. Click the "Create option" at the right of either "Shipping options" or "Return options", based on the type of shipping option you're creating. +3. Click the "Create option" at the right of either "Shipping options", "Pickup options", or "Return options", based on the type of shipping option you're creating. 4. In the form that opens: - - For the "Price type", chose **Fixed** if you want to apply fixed pricing for the shipping option, or **Calculated** if the price should be calculated dynamically during checkout. Calculated prices are useful if you're using a third-party fulfillment provider that calculates prices dynamically. + - If the shipping option isn't a pick-up option, you can choose the price type. Choose **Fixed** if you want to apply fixed pricing for the shipping option, or **Calculated** if the price should be calculated dynamically during checkout. Calculated prices are useful if you're using a third-party fulfillment provider that calculates prices dynamically. - If you chose Fixed, you'll set the price in the next step of the form. - If you choose Calculated and the fulfillment provider you choose doesn't support calculated prices, the shipping option creation will fail. - In the Name field, enter a name for the shipping option. Customers will see this option during checkout. diff --git a/www/apps/user-guide/app/settings/locations-and-shipping/page.mdx b/www/apps/user-guide/app/settings/locations-and-shipping/page.mdx index c9377520f6..fed9a635fe 100644 --- a/www/apps/user-guide/app/settings/locations-and-shipping/page.mdx +++ b/www/apps/user-guide/app/settings/locations-and-shipping/page.mdx @@ -1,7 +1,7 @@ import { EllipsisHorizontal } from "@medusajs/icons" export const metadata = { - title: `Locations & Shipping Overview`, + title: `Locations & Shipping Overview in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx b/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx index 97a7c38727..c1dcc776aa 100644 --- a/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx +++ b/www/apps/user-guide/app/settings/locations-and-shipping/shipping-profiles/page.mdx @@ -1,7 +1,7 @@ import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Shipping Profiles`, + title: `Manage Shipping Profiles in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/page.mdx b/www/apps/user-guide/app/settings/page.mdx index 4fed6e74a2..7370c2076e 100644 --- a/www/apps/user-guide/app/settings/page.mdx +++ b/www/apps/user-guide/app/settings/page.mdx @@ -5,7 +5,7 @@ sidebar_autogenerate_exclude: true import { ArrowUturnLeft } from "@medusajs/icons" export const metadata = { - title: `Settings`, + title: `Settings in Medusa Admin`, } # {metadata.title} @@ -31,7 +31,7 @@ You can also go back to the main sidebar by clicking the icon at the top right of the page. +3. Choose "Edit" from the dropdown. +4. In the side window that opens, you can edit your first and last name, and the Medusa Admin dashboard language. This only changes the language of the admin interface, not the language of the store. It also doesn't change the language for other users in the admin. +5. Once you're done, click the Save button. -{/* TODO add link [here](../../contribution/admin-translations.md). */} +Can't find your language? Learn how you can contribute by translating the admin to other languages [here](!resources!/contribution-guidelines/admin-translations). -Can't find your language? Learn how you can contribute by translating the admin to other languages here. + - \ No newline at end of file +![Edit profile form](https://res.cloudinary.com/dza7lstvk/image/upload/v1740500618/User%20Guide/Screenshot_2025-02-25_at_6.23.21_PM_tbgsbg.png) diff --git a/www/apps/user-guide/app/settings/regions/page.mdx b/www/apps/user-guide/app/settings/regions/page.mdx index b7a550b1f8..6a4487d7d8 100644 --- a/www/apps/user-guide/app/settings/regions/page.mdx +++ b/www/apps/user-guide/app/settings/regions/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 4 import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Regions`, + title: `Manage Regions in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/return-reasons/page.mdx b/www/apps/user-guide/app/settings/return-reasons/page.mdx index a23ab3e640..f33ed112aa 100644 --- a/www/apps/user-guide/app/settings/return-reasons/page.mdx +++ b/www/apps/user-guide/app/settings/return-reasons/page.mdx @@ -6,7 +6,7 @@ sidebar_label: "Return Reasons" import { EllipsisHorizontal } from "@medusajs/icons" export const metadata = { - title: `Manage Return Reasons`, + title: `Manage Return Reasons in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/sales-channels/page.mdx b/www/apps/user-guide/app/settings/sales-channels/page.mdx index 17aaad99ad..ce1fe1e35b 100644 --- a/www/apps/user-guide/app/settings/sales-channels/page.mdx +++ b/www/apps/user-guide/app/settings/sales-channels/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 8 import { EllipsisHorizontal } from "@medusajs/icons" export const metadata = { - title: `Manage Sales Channels`, + title: `Manage Sales Channels in Medusa Admin`, } # {metadata.title} @@ -28,9 +28,7 @@ Sales channels are associated with other data and settings in your commerce stor -{/* TODO add link */} - -Developers can use [Publishable API Keys](#) to easily associate a storefront or client with a sales channel. +Developers can use [Publishable API Keys](../developer/secret-api-keys/page.mdx) to easily associate a storefront or client with a sales channel. diff --git a/www/apps/user-guide/app/settings/store/page.mdx b/www/apps/user-guide/app/settings/store/page.mdx index 5799d2bd2a..54af79753e 100644 --- a/www/apps/user-guide/app/settings/store/page.mdx +++ b/www/apps/user-guide/app/settings/store/page.mdx @@ -6,7 +6,7 @@ sidebar_label: "Store" import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Store`, + title: `Manage Store in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/tax-regions/page.mdx b/www/apps/user-guide/app/settings/tax-regions/page.mdx index 723f2f63c0..dbb9aeb36c 100644 --- a/www/apps/user-guide/app/settings/tax-regions/page.mdx +++ b/www/apps/user-guide/app/settings/tax-regions/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 6 import { EllipsisHorizontal } from "@medusajs/icons" export const metadata = { - title: `Tax Regions`, + title: `Tax Regions in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/users/invites/page.mdx b/www/apps/user-guide/app/settings/users/invites/page.mdx index f3fa051aee..5c1df849d2 100644 --- a/www/apps/user-guide/app/settings/users/invites/page.mdx +++ b/www/apps/user-guide/app/settings/users/invites/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 import { EllipsisHorizontal } from "@medusajs/icons" export const metadata = { - title: `Manage Invites`, + title: `Manage Invites in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/settings/users/page.mdx b/www/apps/user-guide/app/settings/users/page.mdx index 4fb728a5d0..2b0707db90 100644 --- a/www/apps/user-guide/app/settings/users/page.mdx +++ b/www/apps/user-guide/app/settings/users/page.mdx @@ -6,7 +6,7 @@ sidebar_label: Users import { EllipsisHorizontal, ArrowUpRightOnBox, EllipsisVertical } from "@medusajs/icons" export const metadata = { - title: `Manage Users`, + title: `Manage Users in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/tips/bulk-editor/page.mdx b/www/apps/user-guide/app/tips/bulk-editor/page.mdx index d2b0566866..6d7544b628 100644 --- a/www/apps/user-guide/app/tips/bulk-editor/page.mdx +++ b/www/apps/user-guide/app/tips/bulk-editor/page.mdx @@ -5,7 +5,7 @@ sidebar_position: 1 import { getOsShortcut } from "docs-ui" export const metadata = { - title: `Bulk Editor`, + title: `Bulk Editor in Medusa Admin`, } # {metadata.title} @@ -20,8 +20,6 @@ The bulk editor allows you to edit prices or values using a spreadsheet-interfac The bulk editor is used in different areas of the Medusa Admin, such as product-variant pricing. -{/* TODO do we still need this next section? */} - --- ## Toggle Columns View diff --git a/www/apps/user-guide/app/tips/languages/page.mdx b/www/apps/user-guide/app/tips/languages/page.mdx index 54aa8bfbda..5f43cf98db 100644 --- a/www/apps/user-guide/app/tips/languages/page.mdx +++ b/www/apps/user-guide/app/tips/languages/page.mdx @@ -3,7 +3,7 @@ sidebar_position: 2 --- export const metadata = { - title: `Admin Languages`, + title: `Languages in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/app/tips/lists/page.mdx b/www/apps/user-guide/app/tips/lists/page.mdx index 78822958e6..8354c66386 100644 --- a/www/apps/user-guide/app/tips/lists/page.mdx +++ b/www/apps/user-guide/app/tips/lists/page.mdx @@ -6,7 +6,7 @@ sidebar_label: "Lists" import { BarsArrowDown } from "@medusajs/icons" export const metadata = { - title: `Lists Tips`, + title: `Tips for Lists in Medusa Admin`, } # {metadata.title} diff --git a/www/apps/user-guide/generated/edit-dates.mjs b/www/apps/user-guide/generated/edit-dates.mjs index 1cedef2132..48aa550b97 100644 --- a/www/apps/user-guide/generated/edit-dates.mjs +++ b/www/apps/user-guide/generated/edit-dates.mjs @@ -11,24 +11,21 @@ export const generatedEditDates = { "app/settings/regions/page.mdx": "2025-02-19T17:37:17.896Z", "app/orders/page.mdx": "2025-02-17T15:13:42.484Z", "app/settings/users/invites/page.mdx": "2025-02-19T11:38:54.009Z", - "app/settings/developer/page.mdx": "2024-05-03T17:36:38+03:00", - "app/settings/profile/page.mdx": "2024-05-03T17:36:38+03:00", + "app/settings/developer/page.mdx": "2025-02-25T15:11:55.392Z", + "app/settings/profile/page.mdx": "2025-02-25T16:24:21.165Z", "app/settings/store/page.mdx": "2025-02-19T11:19:01.136Z", "app/products/import/page.mdx": "2025-02-18T12:15:03.830Z", - "app/settings/developer/api-key-management/page.mdx": "2024-05-03T17:36:38+03:00", "app/products/categories/page.mdx": "2025-02-19T10:21:42.058Z", "app/inventory/reservations/page.mdx": "2025-02-18T13:56:28.134Z", - "app/settings/developer/api-key-management/sales-channels/page.mdx": "2024-05-03T17:36:38+03:00", "app/discounts/manage/page.mdx": "2024-05-03T17:36:38+03:00", "app/products/page.mdx": "2025-02-18T12:24:19.794Z", - "app/settings/developer/executions/page.mdx": "2024-05-03T17:36:38+03:00", "app/inventory/inventory/page.mdx": "2025-02-18T13:59:16.960Z", "app/customers/groups/page.mdx": "2025-02-18T15:41:30.730Z", "app/orders/manage/page.mdx": "2025-02-18T15:38:17.544Z", "app/orders/returns/page.mdx": "2025-02-17T15:10:11.039Z", "app/inventory/page.mdx": "2025-02-18T13:58:42.393Z", "app/orders/claims/page.mdx": "2025-02-17T15:16:27.380Z", - "app/orders/fulfillments/page.mdx": "2025-02-17T15:12:20.431Z", + "app/orders/fulfillments/page.mdx": "2025-02-25T15:02:02.160Z", "app/customers/page.mdx": "2025-02-18T15:38:17.543Z", "app/orders/edit/page.mdx": "2025-02-17T15:15:53.489Z", "app/products/collections/page.mdx": "2025-02-18T14:00:51.469Z", @@ -37,7 +34,7 @@ export const generatedEditDates = { "app/orders/payments/page.mdx": "2025-02-17T15:10:24.250Z", "app/discounts/page.mdx": "2024-05-03T17:36:38+03:00", "app/orders/exchanges/page.mdx": "2025-02-17T15:14:13.676Z", - "app/products/create/page.mdx": "2025-02-19T12:44:48.560Z", + "app/products/create/page.mdx": "2025-02-25T15:02:02.160Z", "app/products/edit/page.mdx": "2025-02-19T10:18:34.689Z", "app/products/variants/page.mdx": "2025-02-19T12:45:06.674Z", "app/products/create/bundle/page.mdx": "2025-02-18T12:17:32.166Z", @@ -50,9 +47,12 @@ export const generatedEditDates = { "app/price-lists/manage/page.mdx": "2025-02-19T10:35:49.881Z", "app/price-lists/page.mdx": "2025-02-19T09:51:32.546Z", "app/settings/tax-regions/page.mdx": "2025-02-19T17:33:43.806Z", - "app/settings/locations-and-shipping/locations/page.mdx": "2025-02-19T17:28:36.838Z", + "app/settings/locations-and-shipping/locations/page.mdx": "2025-02-25T15:02:02.164Z", "app/settings/locations-and-shipping/page.mdx": "2025-02-19T17:23:45.824Z", "app/settings/locations-and-shipping/shipping-profiles/page.mdx": "2025-02-19T17:36:46.339Z", "app/settings/product-tags/page.mdx": "2025-02-19T17:36:25.102Z", - "app/settings/product-types/page.mdx": "2025-02-19T17:36:16.496Z" + "app/settings/product-types/page.mdx": "2025-02-19T17:36:16.496Z", + "app/settings/developer/publishable-api-keys/page.mdx": "2025-02-25T16:15:29.847Z", + "app/settings/developer/secret-api-keys/page.mdx": "2025-02-25T16:17:40.621Z", + "app/settings/developer/workflows/page.mdx": "2025-02-25T15:52:48.349Z" } \ No newline at end of file diff --git a/www/apps/user-guide/generated/sidebar.mjs b/www/apps/user-guide/generated/sidebar.mjs index 59ce205714..b9de487bfa 100644 --- a/www/apps/user-guide/generated/sidebar.mjs +++ b/www/apps/user-guide/generated/sidebar.mjs @@ -458,15 +458,16 @@ export const generatedSidebar = [ { "loaded": true, "isPathHref": true, - "type": "category", + "type": "link", "title": "Developer Settings", + "path": "/settings/developer", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "title": "Publishable API Keys", - "path": "#", + "path": "/settings/developer/publishable-api-keys", "children": [] }, { @@ -474,7 +475,7 @@ export const generatedSidebar = [ "isPathHref": true, "type": "link", "title": "Secret API Keys", - "path": "#", + "path": "/settings/developer/secret-api-keys", "children": [] }, { @@ -482,7 +483,7 @@ export const generatedSidebar = [ "isPathHref": true, "type": "link", "title": "Workflows", - "path": "/settings/executions", + "path": "/settings/developer/workflows", "children": [] } ] diff --git a/www/apps/user-guide/sidebar.mjs b/www/apps/user-guide/sidebar.mjs index 7e385d9f21..c60b0acf6e 100644 --- a/www/apps/user-guide/sidebar.mjs +++ b/www/apps/user-guide/sidebar.mjs @@ -284,23 +284,24 @@ export const sidebar = sidebarAttachHrefCommonOptions([ ], }, { - type: "category", + type: "link", title: "Developer Settings", + path: "/settings/developer", children: [ { type: "link", title: "Publishable API Keys", - path: "#", + path: "/settings/developer/publishable-api-keys", }, { type: "link", title: "Secret API Keys", - path: "#", + path: "/settings/developer/secret-api-keys", }, { type: "link", title: "Workflows", - path: "/settings/executions", + path: "/settings/developer/workflows", }, ], },