Skip to content

Commit

Permalink
docs: add notes + missing links for user guide (#11621)
Browse files Browse the repository at this point in the history
* docs: add notes + missing links for user guide

* fix build errors

* fixes
  • Loading branch information
shahednasser authored Feb 26, 2025
1 parent 322d108 commit 95eef89
Show file tree
Hide file tree
Showing 76 changed files with 732 additions and 790 deletions.
2 changes: 1 addition & 1 deletion www/apps/api-reference/markdown/admin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Use a user's secret API Token to send authenticated requests.

#### How to Create an API Token for a User

Create the API key token either from the Medusa Admin or using the [Create API Key API Route](#api-keys_postapikeys).
Create the API key token either from the [Medusa Admin](!user-guide!/settings/developer/secret-api-keys) or using the [Create API Key API Route](#api-keys_postapikeys).

<Note>

Expand Down
1 change: 1 addition & 0 deletions www/apps/book/app/learn/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ This documentation is split into the following sections:
1. The main documentation, which is the one you're currently reading. It's recommended to follow the chapters in this documentation to understand the core concepts of Medusa and how to use them.
2. The [Development Resources documentation](!resources!) provides guides and resources useful during your development, such as tools, API references, recipes, step-by-step guides and examples, and more.
3. The [Store](!api!/store) and [Admin](!api!/admin) API references provide a reference to the Medusa application's endpoints and instructions related to authentication, parameter types in requests, and more.
4. The [User Guide](!user-guide!) introduces you to the Medusa Admin dashboard and helps merchants and store managers understand how to use the dashboard to manage their store.

To get started, check out the [Installation chapter](./installation/page.mdx).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,4 @@ Then, start the Medusa application:
npm run dev
```

{/* TODO add links */}

And create a product either using the [API route](!api!/admin#products_postproducts) or the Medusa Admin. This runs the subscriber and sends an email using SendGrid.
And create a product either using the [API route](!api!/admin#products_postproducts) or the [Medusa Admin](!user-guide!/products/create). This runs the subscriber and sends an email using SendGrid.
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/api-key/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the API Key Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/settings/developer) to learn how to manage publishable and secret API keys using the dashboard.

</Note>

Medusa has API-key related features available out-of-the-box through the API Key Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this API Key Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this guide, you'll learn how to handle the `auth.password_reset` event, which is emitted when a request is sent to the [Generate Reset Password Token API route](../authentication-route/page.mdx#generate-reset-password-token-route).

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/reset-password) to learn how to reset your user admin password using the dashboard.

</Note>

You'll create a subscriber that listens to the event. When the event is emitted, the subscriber sends an email notification to the user.

<Prerequisites
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/currency/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Currency Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/settings/store) to learn how to manage your store's currencies using the dashboard.

</Note>

Medusa has currency related features available out-of-the-box through the Currency Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Currency Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ export const metadata = {

In this document, you’ll learn how registered and unregistered accounts are distinguished in the Medusa application.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/customers) to learn how to manage customers using the dashboard.

</Note>

## `has_account` Property

The [Customer data model](/references/customer/models/Customer) has a `has_account` property, which is a boolean that indicates whether a customer is registered.
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/customer/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Customer Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/customers) to learn how to manage customers and groups using the dashboard.

</Note>

Medusa has customer related features available out-of-the-box through the Customer Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Customer Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ export const metadata = {

In this document, you’ll learn what a fulfillment module provider is.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/settings/locations-and-shipping/locations#manage-fulfillment-providers) to learn how to add a fulfillment provider to a location using the dashboard.

</Note>

## What’s a Fulfillment Module Provider?

A fulfillment module provider handles fulfilling items, typically using a third-party integration.
Expand Down
9 changes: 9 additions & 0 deletions www/apps/resources/app/commerce-modules/fulfillment/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Fulfillment Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the Medusa Admin User Guide to learn how to use the dashboard to:

- [Manage order fulfillments](!user-guide!/orders/fulfillments).
- [Manage shipping options and profiles](!user-guide!/settings/locations-and-shipping).

</Note>

Medusa has fulfillment related features available out-of-the-box through the Fulfillment Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Fulfillment Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ export const metadata = {

In this guide, you'll learn how inventory kits can be used in the Medusa application to support use cases like multi-part products, bundled products, and shared inventory across products.

<Note title="Looking for no-code docs?">

Refer to the following user guides to learn how to use the Medusa Admin dashboard to:

- [Create Multi-Part Products](!user-guide!/products/create/multi-part).
- [Create Bundled Products](!user-guide!/products/create/bundle).

</Note>

## What is an Inventory Kit?

An inventory kit is a collection of inventory items that are linked to a single product variant. These inventory items can be used to represent different parts of a product, or to represent a bundle of products.
Expand Down Expand Up @@ -42,7 +51,7 @@ Then, whenever a customer purchases a bicycle, the inventory of each part is upd

### Create Multi-Part Product

Using the Medusa Admin, you can create a multi-part product by creating its inventory items first, then assigning these inventory items to the product's variant(s).
Using the [Medusa Admin](!user-guide!/products/create/multi-part), you can create a multi-part product by creating its inventory items first, then assigning these inventory items to the product's variant(s).

Using [workflows](!docs!/learn/fundamentals/workflows), you can implement this by first creating the inventory items:

Expand Down Expand Up @@ -205,7 +214,7 @@ Then, when the bundled product's variant is purchased, the inventory quantity of

### Create Bundled Product

You can create a bundled product in the Medusa Admin by creating the products part of the bundle first, each having its own inventory items. Then, you create the bundled product whose variant(s) have inventory kits composed of inventory items from each of the products part of the bundle.
You can create a bundled product in the [Medusa Admin](!user-guide!/products/create/bundle) by creating the products part of the bundle first, each having its own inventory items. Then, you create the bundled product whose variant(s) have inventory kits composed of inventory items from each of the products part of the bundle.

Using [workflows](!docs!/learn/fundamentals/workflows), you can implement this by first creating the products part of the bundle:

Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/inventory/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Inventory Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/inventory) to learn how to manage inventory and related features using the dashboard.

</Note>

Medusa has inventory related features available out-of-the-box through the Inventory Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Inventory Module.

<Note>
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/order/claim/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ export const metadata = {

In this document, you’ll learn about order claims.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/orders/claims) to learn how to manage an order's claims using the dashboard.

</Note>

## What is a Claim?

When a customer receives a defective or incorrect item, the merchant can create a claim to refund or replace the item.
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/order/edit/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ export const metadata = {

In this document, you'll learn about order edits.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/orders/edit) to learn how to edit an order's items using the dashboard.

</Note>

## What is an Order Edit?

A merchant can edit an order to add new items or change the quantity of existing items in the order.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this document, you’ll learn about order exchanges.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/orders/exchanges) to learn how to manage an order's exchanges using the dashboard.

</Note>

## What is an Exchange?

An exchange is the replacement of an item that the customer ordered with another.
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/order/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Order Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/orders) to learn how to manage orders using the dashboard.

</Note>

Medusa has order related features available out-of-the-box through the Order Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Order Module.

<Note>
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/order/return/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ export const metadata = {

In this document, you’ll learn about order returns.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/orders/returns) to learn how to manage an order's returns using the dashboard.

</Note>

## What is a Return?

A return is the return of items delivered from the customer back to the merchant. It is represented by the [Return data model](/references/order/models/Return).
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/payment/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Payment Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/orders/payments) to learn how to manage order payments using the dashboard.

</Note>

Medusa has payment related features available out-of-the-box through the Payment Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Payment Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this document, you’ll learn what a payment module provider is.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/settings/regions) to learn how to manage the payment providers available in a region using the dashboard.

</Note>

## What's a Payment Module Provider?

A payment module provider registers a payment provider that handles payment processing in the Medusa application. It integrates third-party payment providers, such as Stripe.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ export const metadata = {

In this document, you’ll learn about the Stripe Module Provider and how to configure it in the Payment Module.

<Note title="Looking for no-code docs?">

Your technical team must install the Stripe Module Provider in your Medusa application first. Then, refer to [this user guide](!user-guide!/settings/regions#edit-region-details) to learn how to enable the Stripe payment provider in a region using the Medusa Admin dashboard.

</Note>

## Register the Stripe Module Provider

<Prerequisites items={[
Expand Down Expand Up @@ -192,6 +198,14 @@ STRIPE_API_KEY=<YOUR_STRIPE_API_KEY>

---

## Enable Stripe Providers in a Region

Before customers can use Stripe to complete their purchases, you must enable the Stripe payment provider(s) in the region where you want to offer this payment method.

Refer to the [user guide](!user-guide!/settings/regions#edit-region-details) to learn how to edit a region and enable the Stripe payment provider.

---

## Setup Stripe Webhooks

For production applications, you must set up webhooks in Stripe that inform Medusa of changes and updates to payments. Refer to [Stripe's documentation](https://docs.stripe.com/webhooks#add-a-webhook-endpoint) on how to setup webhooks.
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/pricing/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Pricing Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/price-lists) to learn how to manage price lists using the dashboard.

</Note>

Medusa has pricing related features available out-of-the-box through the Pricing Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Pricing Module.

<Note>
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/product/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Product Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/products) to learn how to manage products using the dashboard.

</Note>

Medusa has product related features available out-of-the-box through the Product Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Product Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ export const metadata = {

In this guide, you'll learn about the inventory management features related to product variants.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/products/variants#manage-product-variant-inventory) to learn how to manage inventory of product variants.

</Note>

## Configure Inventory Management of Product Variants

A product variant, represented by the [ProductVariant](/references/product/models/ProductVariant) data model, has a `manage_inventory` field that's disabled by default. This field indicates whether you'll manage the inventory quantity of the product variant in the Medusa application. You can also keep `manage_inventory` disabled if you manage the product's inventory in an external system, such as an ERP.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ export const metadata = {

In this document, you'll learn about campaigns.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/promotions/campaigns) to learn how to manage campaigns using the dashboard.

</Note>

## What is a Campaign?

A [Campaign](/references/promotion/models/Campaign) combines promotions under the same conditions, such as start and end dates.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this document, you’ll learn about the main promotion and rule concepts in the Promotion Module.

<Note title="Looking for no-code docs?">

Refer to this [Medusa Admin User Guide](!user-guide!/promotions) to learn how to manage promotions using the dashboard.

</Note>

## What is a Promotion?

A promotion, represented by the [Promotion data model](/references/promotion/models/Promotion), is a discount that can be applied on cart items, shipping methods, or entire orders.
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/promotion/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Promotion Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/promotions) to learn how to manage promotions using the dashboard.

</Note>

Medusa has promotion related features available out-of-the-box through the Promotion Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Promotion Module.

<Note>
Expand Down
6 changes: 6 additions & 0 deletions www/apps/resources/app/commerce-modules/region/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Region Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/settings/regions) to learn how to manage regions using the dashboard.

</Note>

Medusa has region related features available out-of-the-box through the Region Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Region Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ export const metadata = {

In this section of the documentation, you will find resources to learn more about the Sales Channel Module and how to use it in your application.

<Note title="Looking for no-code docs?">

Refer to the [Medusa Admin User Guide](!user-guide!/settings/sales-channels) to learn how to manage sales channels using the dashboard.

</Note>

Medusa has sales channel related features available out-of-the-box through the Sales Channel Module. A [module](!docs!/learn/fundamentals/modules) is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Sales Channel Module.

<Note>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ The Medusa application infers the associated sales channels and ensures that onl

## How to Create a Publishable API Key?

To create a publishable API key, either use the Medusa Admin or the [Admin API Routes](!api!/admin#publishable-api-keys).
To create a publishable API key, either use the [Medusa Admin](!user-guide!/settings/developer/publishable-api-keys) or the [Admin API Routes](!api!/admin#publishable-api-keys).
Loading

0 comments on commit 95eef89

Please sign in to comment.