Skip to content

Commit 95eef89

Browse files
authored
docs: add notes + missing links for user guide (#11621)
* docs: add notes + missing links for user guide * fix build errors * fixes
1 parent 322d108 commit 95eef89

File tree

76 files changed

+732
-790
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+732
-790
lines changed

www/apps/api-reference/markdown/admin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Use a user's secret API Token to send authenticated requests.
147147

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

150-
Create the API key token either from the Medusa Admin or using the [Create API Key API Route](#api-keys_postapikeys).
150+
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).
151151

152152
<Note>
153153

www/apps/book/app/learn/page.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ This documentation is split into the following sections:
8181
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.
8282
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.
8383
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.
84+
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.
8485

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

www/apps/resources/app/architectural-modules/notification/sendgrid/page.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,4 @@ Then, start the Medusa application:
181181
npm run dev
182182
```
183183

184-
{/* TODO add links */}
185-
186-
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.
184+
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.

www/apps/resources/app/commerce-modules/api-key/page.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ export const metadata = {
88

99
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.
1010

11+
<Note title="Looking for no-code docs?">
12+
13+
Refer to the [Medusa Admin User Guide](!user-guide!/settings/developer) to learn how to manage publishable and secret API keys using the dashboard.
14+
15+
</Note>
16+
1117
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.
1218

1319
<Note>

www/apps/resources/app/commerce-modules/auth/reset-password/page.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ export const metadata = {
88

99
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).
1010

11+
<Note title="Looking for no-code docs?">
12+
13+
Refer to this [Medusa Admin User Guide](!user-guide!/reset-password) to learn how to reset your user admin password using the dashboard.
14+
15+
</Note>
16+
1117
You'll create a subscriber that listens to the event. When the event is emitted, the subscriber sends an email notification to the user.
1218

1319
<Prerequisites

www/apps/resources/app/commerce-modules/currency/page.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ export const metadata = {
88

99
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.
1010

11+
<Note title="Looking for no-code docs?">
12+
13+
Refer to the [Medusa Admin User Guide](!user-guide!/settings/store) to learn how to manage your store's currencies using the dashboard.
14+
15+
</Note>
16+
1117
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.
1218

1319
<Note>

www/apps/resources/app/commerce-modules/customer/customer-accounts/page.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ export const metadata = {
66

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

9+
<Note title="Looking for no-code docs?">
10+
11+
Refer to this [Medusa Admin User Guide](!user-guide!/customers) to learn how to manage customers using the dashboard.
12+
13+
</Note>
14+
915
## `has_account` Property
1016

1117
The [Customer data model](/references/customer/models/Customer) has a `has_account` property, which is a boolean that indicates whether a customer is registered.

www/apps/resources/app/commerce-modules/customer/page.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ export const metadata = {
88

99
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.
1010

11+
<Note title="Looking for no-code docs?">
12+
13+
Refer to the [Medusa Admin User Guide](!user-guide!/customers) to learn how to manage customers and groups using the dashboard.
14+
15+
</Note>
16+
1117
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.
1218

1319
<Note>

www/apps/resources/app/commerce-modules/fulfillment/fulfillment-provider/page.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ export const metadata = {
66

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

9+
<Note title="Looking for no-code docs?">
10+
11+
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.
12+
13+
</Note>
14+
915
## What’s a Fulfillment Module Provider?
1016

1117
A fulfillment module provider handles fulfilling items, typically using a third-party integration.

www/apps/resources/app/commerce-modules/fulfillment/page.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ export const metadata = {
88

99
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.
1010

11+
<Note title="Looking for no-code docs?">
12+
13+
Refer to the Medusa Admin User Guide to learn how to use the dashboard to:
14+
15+
- [Manage order fulfillments](!user-guide!/orders/fulfillments).
16+
- [Manage shipping options and profiles](!user-guide!/settings/locations-and-shipping).
17+
18+
</Note>
19+
1120
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.
1221

1322
<Note>

0 commit comments

Comments
 (0)