Skip to content

Commit 0a43009

Browse files
authored
docs: freshness check for some guides (medusajs#13000)
1 parent 798ac00 commit 0a43009

File tree

5 files changed

+18
-17
lines changed

5 files changed

+18
-17
lines changed

www/apps/book/app/learn/customization/custom-features/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ In the upcoming chapters, you'll follow step-by-step guides to build custom feat
88

99
By following these guides, you'll add brands to the Medusa application that you can associate with products.
1010

11-
To build a custom feature in Medusa, you need three main tools:
11+
To build a custom feature in Medusa, you need three main [Framework](../../fundamentals/framework/page.mdx) tools:
1212

1313
- [Module](../../fundamentals/modules/page.mdx): a package with commerce logic for a single domain. It defines new tables to add to the database, and a class of methods to manage these tables.
1414
- [Workflow](../../fundamentals/workflows/page.mdx): a tool to perform an operation comprising multiple steps with built-in rollback and retry mechanisms.

www/apps/book/app/learn/customization/customize-admin/page.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ In the previous chapters, you've customized your Medusa application to [add bran
88

99
After customizing and extending your application with new features, you may need to provide an interface for admin users to utilize these features. The Medusa Admin dashboard is extendable, allowing you to:
1010

11-
- Insert components, called [widgets](../../fundamentals/admin/widgets/page.mdx), on existing pages.
12-
- Add new pages, called [UI Routes](../../fundamentals/admin/ui-routes/page.mdx).
11+
- Insert components, called [widgets](../../fundamentals/admin/widgets/page.mdx), into existing pages. For example, you can add a widget to the product details page that shows the product's brand.
12+
- Add new pages, called [UI Routes](../../fundamentals/admin/ui-routes/page.mdx). For example, you can create a new page in the dashboard that lists all brands in the store.
1313

14-
From these customizations, you can send requests to custom API routes, allowing admin users to manage custom resources on the dashboard
14+
Within these customizations, you can send requests to custom API routes, allowing admin users to view and manage custom resources on the dashboard.
1515

1616
---
1717

www/apps/book/app/learn/fundamentals/admin/constraints/page.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ export const metadata = {
44

55
# {metadata.title}
66

7-
This chapter lists some constraints of admin widgets and UI routes.
7+
This chapter lists some development constraints of admin widgets and UI routes.
88

99
## Arrow Functions
1010

11-
Widget and UI route components must be created as arrow functions.
11+
Widget and UI route components must be created as arrow functions. Otherwise, Medusa doesn't register them correctly.
1212

1313
export const arrowHighlights = [
1414
["2", "function", "Don't declare the widget / UI route as a function."],
@@ -31,7 +31,7 @@ const ProductWidget = () => {
3131

3232
## Widget Zone
3333

34-
A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable.
34+
A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable. Otherwise, Medusa doesn't register the widget correctly.
3535

3636
export const zoneHighlights = [
3737
["3", "`product.details.before`", "Don't specify the value of `zone` as a template literal."],

www/apps/book/generated/edit-dates.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export const generatedEditDates = {
6060
"app/learn/fundamentals/api-routes/responses/page.mdx": "2024-10-21T13:30:21.367Z",
6161
"app/learn/fundamentals/api-routes/validation/page.mdx": "2025-03-24T06:52:47.896Z",
6262
"app/learn/fundamentals/api-routes/errors/page.mdx": "2025-06-19T16:09:08.563Z",
63-
"app/learn/fundamentals/admin/constraints/page.mdx": "2024-10-21T13:30:21.366Z",
63+
"app/learn/fundamentals/admin/constraints/page.mdx": "2025-07-21T08:20:43.223Z",
6464
"app/learn/debugging-and-testing/testing-tools/modules-tests/page.mdx": "2025-07-18T12:24:02.385Z",
6565
"app/learn/fundamentals/module-links/custom-columns/page.mdx": "2025-03-11T13:29:54.752Z",
6666
"app/learn/fundamentals/module-links/directions/page.mdx": "2025-03-17T12:52:06.161Z",
@@ -76,8 +76,8 @@ export const generatedEditDates = {
7676
"app/learn/customization/custom-features/module/page.mdx": "2025-05-06T16:10:50.090Z",
7777
"app/learn/customization/custom-features/workflow/page.mdx": "2024-12-09T14:36:29.482Z",
7878
"app/learn/customization/extend-features/extend-create-product/page.mdx": "2025-01-06T11:18:58.250Z",
79-
"app/learn/customization/custom-features/page.mdx": "2024-12-09T10:46:28.593Z",
80-
"app/learn/customization/customize-admin/page.mdx": "2024-12-09T11:02:38.801Z",
79+
"app/learn/customization/custom-features/page.mdx": "2025-07-21T08:17:33.542Z",
80+
"app/learn/customization/customize-admin/page.mdx": "2025-07-21T08:19:07.699Z",
8181
"app/learn/customization/customize-admin/route/page.mdx": "2025-02-11T15:56:03.835Z",
8282
"app/learn/customization/customize-admin/widget/page.mdx": "2025-02-05T09:10:18.163Z",
8383
"app/learn/customization/extend-features/define-link/page.mdx": "2025-04-17T08:50:17.036Z",

www/apps/book/public/llms-full.txt

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1524,7 +1524,7 @@ In the upcoming chapters, you'll follow step-by-step guides to build custom feat
15241524

15251525
By following these guides, you'll add brands to the Medusa application that you can associate with products.
15261526

1527-
To build a custom feature in Medusa, you need three main tools:
1527+
To build a custom feature in Medusa, you need three main [Framework](https://docs.medusajs.com/learn/fundamentals/framework/index.html.md) tools:
15281528

15291529
- [Module](https://docs.medusajs.com/learn/fundamentals/modules/index.html.md): a package with commerce logic for a single domain. It defines new tables to add to the database, and a class of methods to manage these tables.
15301530
- [Workflow](https://docs.medusajs.com/learn/fundamentals/workflows/index.html.md): a tool to perform an operation comprising multiple steps with built-in rollback and retry mechanisms.
@@ -1687,10 +1687,10 @@ In the previous chapters, you've customized your Medusa application to [add bran
16871687

16881688
After customizing and extending your application with new features, you may need to provide an interface for admin users to utilize these features. The Medusa Admin dashboard is extendable, allowing you to:
16891689

1690-
- Insert components, called [widgets](https://docs.medusajs.com/learn/fundamentals/admin/widgets/index.html.md), on existing pages.
1691-
- Add new pages, called [UI Routes](https://docs.medusajs.com/learn/fundamentals/admin/ui-routes/index.html.md).
1690+
- Insert components, called [widgets](https://docs.medusajs.com/learn/fundamentals/admin/widgets/index.html.md), into existing pages. For example, you can add a widget to the product details page that shows the product's brand.
1691+
- Add new pages, called [UI Routes](https://docs.medusajs.com/learn/fundamentals/admin/ui-routes/index.html.md). For example, you can create a new page in the dashboard that lists all brands in the store.
16921692

1693-
From these customizations, you can send requests to custom API routes, allowing admin users to manage custom resources on the dashboard
1693+
Within these customizations, you can send requests to custom API routes, allowing admin users to view and manage custom resources on the dashboard.
16941694

16951695
***
16961696

@@ -4757,6 +4757,7 @@ module.exports = {
47574757
{
47584758
jsc: {
47594759
parser: { syntax: "typescript", decorators: true },
4760+
target: "es2021"
47604761
},
47614762
},
47624763
],
@@ -5194,11 +5195,11 @@ Refer to [this reference](https://docs.medusajs.com/resources/deployment/index.h
51945195

51955196
# Admin Development Constraints
51965197

5197-
This chapter lists some constraints of admin widgets and UI routes.
5198+
This chapter lists some development constraints of admin widgets and UI routes.
51985199

51995200
## Arrow Functions
52005201

5201-
Widget and UI route components must be created as arrow functions.
5202+
Widget and UI route components must be created as arrow functions. Otherwise, Medusa doesn't register them correctly.
52025203

52035204
```ts highlights={arrowHighlights}
52045205
// Don't
@@ -5216,7 +5217,7 @@ const ProductWidget = () => {
52165217

52175218
## Widget Zone
52185219

5219-
A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable.
5220+
A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable. Otherwise, Medusa doesn't register the widget correctly.
52205221

52215222
```ts highlights={zoneHighlights}
52225223
// Don't

0 commit comments

Comments
 (0)