docs: freshness check for some guides (#13000)
This commit is contained in:
Shahed Nasser
GitHub
@@ -8,7 +8,7 @@ In the upcoming chapters, you'll follow step-by-step guides to build custom feat
|
||||
|
||||
By following these guides, you'll add brands to the Medusa application that you can associate with products.
|
||||
|
||||
To build a custom feature in Medusa, you need three main tools:
|
||||
To build a custom feature in Medusa, you need three main [Framework](../../fundamentals/framework/page.mdx) tools:
|
||||
|
||||
- [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.
|
||||
- [Workflow](../../fundamentals/workflows/page.mdx): a tool to perform an operation comprising multiple steps with built-in rollback and retry mechanisms.
|
||||
|
||||
@@ -8,10 +8,10 @@ In the previous chapters, you've customized your Medusa application to [add bran
|
||||
|
||||
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:
|
||||
|
||||
- Insert components, called [widgets](../../fundamentals/admin/widgets/page.mdx), on existing pages.
|
||||
- Add new pages, called [UI Routes](../../fundamentals/admin/ui-routes/page.mdx).
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
From these customizations, you can send requests to custom API routes, allowing admin users to manage custom resources on the dashboard
|
||||
Within these customizations, you can send requests to custom API routes, allowing admin users to view and manage custom resources on the dashboard.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -4,11 +4,11 @@ export const metadata = {
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This chapter lists some constraints of admin widgets and UI routes.
|
||||
This chapter lists some development constraints of admin widgets and UI routes.
|
||||
|
||||
## Arrow Functions
|
||||
|
||||
Widget and UI route components must be created as arrow functions.
|
||||
Widget and UI route components must be created as arrow functions. Otherwise, Medusa doesn't register them correctly.
|
||||
|
||||
export const arrowHighlights = [
|
||||
["2", "function", "Don't declare the widget / UI route as a function."],
|
||||
@@ -31,7 +31,7 @@ const ProductWidget = () => {
|
||||
|
||||
## Widget Zone
|
||||
|
||||
A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable.
|
||||
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.
|
||||
|
||||
export const zoneHighlights = [
|
||||
["3", "`product.details.before`", "Don't specify the value of `zone` as a template literal."],
|
||||
|
||||
@@ -60,7 +60,7 @@ export const generatedEditDates = {
|
||||
"app/learn/fundamentals/api-routes/responses/page.mdx": "2024-10-21T13:30:21.367Z",
|
||||
"app/learn/fundamentals/api-routes/validation/page.mdx": "2025-03-24T06:52:47.896Z",
|
||||
"app/learn/fundamentals/api-routes/errors/page.mdx": "2025-06-19T16:09:08.563Z",
|
||||
"app/learn/fundamentals/admin/constraints/page.mdx": "2024-10-21T13:30:21.366Z",
|
||||
"app/learn/fundamentals/admin/constraints/page.mdx": "2025-07-21T08:20:43.223Z",
|
||||
"app/learn/debugging-and-testing/testing-tools/modules-tests/page.mdx": "2025-07-18T12:24:02.385Z",
|
||||
"app/learn/fundamentals/module-links/custom-columns/page.mdx": "2025-03-11T13:29:54.752Z",
|
||||
"app/learn/fundamentals/module-links/directions/page.mdx": "2025-03-17T12:52:06.161Z",
|
||||
@@ -76,8 +76,8 @@ export const generatedEditDates = {
|
||||
"app/learn/customization/custom-features/module/page.mdx": "2025-05-06T16:10:50.090Z",
|
||||
"app/learn/customization/custom-features/workflow/page.mdx": "2024-12-09T14:36:29.482Z",
|
||||
"app/learn/customization/extend-features/extend-create-product/page.mdx": "2025-01-06T11:18:58.250Z",
|
||||
"app/learn/customization/custom-features/page.mdx": "2024-12-09T10:46:28.593Z",
|
||||
"app/learn/customization/customize-admin/page.mdx": "2024-12-09T11:02:38.801Z",
|
||||
"app/learn/customization/custom-features/page.mdx": "2025-07-21T08:17:33.542Z",
|
||||
"app/learn/customization/customize-admin/page.mdx": "2025-07-21T08:19:07.699Z",
|
||||
"app/learn/customization/customize-admin/route/page.mdx": "2025-02-11T15:56:03.835Z",
|
||||
"app/learn/customization/customize-admin/widget/page.mdx": "2025-02-05T09:10:18.163Z",
|
||||
"app/learn/customization/extend-features/define-link/page.mdx": "2025-04-17T08:50:17.036Z",
|
||||
|
||||
@@ -1524,7 +1524,7 @@ In the upcoming chapters, you'll follow step-by-step guides to build custom feat
|
||||
|
||||
By following these guides, you'll add brands to the Medusa application that you can associate with products.
|
||||
|
||||
To build a custom feature in Medusa, you need three main tools:
|
||||
To build a custom feature in Medusa, you need three main [Framework](https://docs.medusajs.com/learn/fundamentals/framework/index.html.md) tools:
|
||||
|
||||
- [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.
|
||||
- [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
|
||||
|
||||
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:
|
||||
|
||||
- Insert components, called [widgets](https://docs.medusajs.com/learn/fundamentals/admin/widgets/index.html.md), on existing pages.
|
||||
- Add new pages, called [UI Routes](https://docs.medusajs.com/learn/fundamentals/admin/ui-routes/index.html.md).
|
||||
- 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.
|
||||
- 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.
|
||||
|
||||
From these customizations, you can send requests to custom API routes, allowing admin users to manage custom resources on the dashboard
|
||||
Within these customizations, you can send requests to custom API routes, allowing admin users to view and manage custom resources on the dashboard.
|
||||
|
||||
***
|
||||
|
||||
@@ -4757,6 +4757,7 @@ module.exports = {
|
||||
{
|
||||
jsc: {
|
||||
parser: { syntax: "typescript", decorators: true },
|
||||
target: "es2021"
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -5194,11 +5195,11 @@ Refer to [this reference](https://docs.medusajs.com/resources/deployment/index.h
|
||||
|
||||
# Admin Development Constraints
|
||||
|
||||
This chapter lists some constraints of admin widgets and UI routes.
|
||||
This chapter lists some development constraints of admin widgets and UI routes.
|
||||
|
||||
## Arrow Functions
|
||||
|
||||
Widget and UI route components must be created as arrow functions.
|
||||
Widget and UI route components must be created as arrow functions. Otherwise, Medusa doesn't register them correctly.
|
||||
|
||||
```ts highlights={arrowHighlights}
|
||||
// Don't
|
||||
@@ -5216,7 +5217,7 @@ const ProductWidget = () => {
|
||||
|
||||
## Widget Zone
|
||||
|
||||
A widget zone's value must be wrapped in double or single quotes. It can't be a template literal or a variable.
|
||||
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.
|
||||
|
||||
```ts highlights={zoneHighlights}
|
||||
// Don't
|
||||
|
||||
Reference in New Issue
Block a user