docs: fix broken links utility + uncaught broken links (#12637)

* fix broken links

* update broken links utility

* add missing payment evens

* generate llms

* fix segment link
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-05-28 17:13:27 +03:00
1 parent 9866baa852
commit 40e73c6ea2
64 files changed
+151813 -150840

No files matched your search

@@ -126,7 +126,7 @@ A table for the link is now created in the database. You can now retrieve and ma
When a customer is created, you also want to create a `Custom` record and set the `custom_name` property, then create a link between the `Customer` and `Custom` records.
To do that, you'll consume the [customersCreated](/resources/references/medusa-workflows/createCustomersWorkflow#customerscreated) hook of the [createCustomersWorkflow](/references/medusa-workflows/createCustomersWorkflow). This workflow is executed in the [Create Customer Admin API route](!api!/admin#customers_postcustomers)
To do that, you'll consume the [customersCreated](/references/medusa-workflows/createCustomersWorkflow#customerscreated) hook of the [createCustomersWorkflow](/references/medusa-workflows/createCustomersWorkflow). This workflow is executed in the [Create Customer Admin API route](!api!/admin#customers_postcustomers)
<Note title="Tip">
@@ -88,7 +88,7 @@ The Fulfillment Module has the following links to other modules:
</Table.Row>
<Table.Row>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
[StockLocation](/references/stock-location-next/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
</Table.Cell>
<Table.Cell>
[FulfillmentProvider](/references/fulfillment/models/FulfillmentProvider)
@@ -102,7 +102,7 @@ The Fulfillment Module has the following links to other modules:
</Table.Row>
<Table.Row>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
[StockLocation](/references/stock-location-next/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
</Table.Cell>
<Table.Cell>
[FulfillmentSet](/references/fulfillment/models/FulfillmentSet)
@@ -52,7 +52,6 @@ These rules are represented by the [ShippingOptionRule data model](/references/f
- `operator`: The operator used in the condition. For example:
- To allow multiple values, use the operator `in`, which validates that the provided values are in the rule’s values.
- To create a negation condition that considers `value` against the rule, use `nin`, which validates that the provided values aren’t in the rule’s values.
- Check out more operators in [this reference](/references/fulfillment/types/fulfillment.RuleOperatorType).
- `value`: One or more values.
![A diagram showcasing the relation between shipping option and shipping option rules.](https://res.cloudinary.com/dza7lstvk/image/upload/v1712331340/Medusa%20Resources/shipping-option-rule_oosopf.jpg)
@@ -41,7 +41,7 @@ Read-only links are used to query data across modules, but the relations aren't
[ProductVariant](/references/product/models/ProductVariant) in [Product Module](../../product/page.mdx)
</Table.Cell>
<Table.Cell>
[InventoryItem](/references/inventory/models/InventoryItem)
[InventoryItem](/references/inventory-next/models/InventoryItem)
</Table.Cell>
<Table.Cell>
Stored - many-to-many
@@ -52,10 +52,10 @@ Read-only links are used to query data across modules, but the relations aren't
</Table.Row>
<Table.Row>
<Table.Cell>
[InventoryLevel](/references/inventory/models/InventoryLevel)
[InventoryLevel](/references/inventory-next/models/InventoryLevel)
</Table.Cell>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
[StockLocation](/references/stock-location-next/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
</Table.Cell>
<Table.Cell>
Read-only - has many
@@ -26,7 +26,7 @@ Once the merchant receives the returned items, they mark the return as received.
## Returned Items
The items to be returned are represented by the [ReturnItem data model](references/order/models/ReturnItem).
The items to be returned are represented by the [ReturnItem data model](/references/order/models/ReturnItem).
The `ReturnItem` model has two properties storing the item's quantity:
@@ -37,7 +37,7 @@ The `ReturnItem` model has two properties storing the item's quantity:
## Return Shipping Methods
A return has shipping methods used to return the items to the merchant. The shipping methods are represented by the [OrderShippingMethod data model](references/order/models/OrderShippingMethod).
A return has shipping methods used to return the items to the merchant. The shipping methods are represented by the [OrderShippingMethod data model](/references/order/models/OrderShippingMethod).
In the Medusa application, the shipping method for a return is created only from a shipping option, provided by the Fulfillment Module, that has the rule `is_return` enabled.
@@ -47,7 +47,7 @@ In the Medusa application, the shipping method for a return is created only from
The `refund_amount` property of the `Return` data model holds the amount a merchant must refund the customer.
The [OrderTransaction data model](references/order/models/OrderTransaction) represents the refunds made for the return.
The [OrderTransaction data model](/references/order/models/OrderTransaction) represents the refunds made for the return.
---
@@ -69,7 +69,7 @@ Read-only links are used to query data across modules, but the relations aren't
[ProductVariant](/references/product/models/ProductVariant)
</Table.Cell>
<Table.Cell>
[InventoryItem](/references/inventory/models/InventoryItem) in [Inventory Module](../../inventory/page.mdx)
[InventoryItem](/references/inventory-next/models/InventoryItem) in [Inventory Module](../../inventory/page.mdx)
</Table.Cell>
<Table.Cell>
Stored - many-to-many
@@ -123,7 +123,7 @@ In this case, a customer’s group must be in the `VIP` and `B2B` set of values
If you're managing promotions using [Medusa's workflows](../../../medusa-workflows-reference/page.mdx) or the API routes that use them, you can specify rules for the promotion or its [application method](../application-method/page.mdx).
For example, if you're creating a promotion using the [createPromotionsWorkflow](!resources!/references/medusa-workflows/createPromotionsWorkflow):
For example, if you're creating a promotion using the [createPromotionsWorkflow](/references/medusa-workflows/createPromotionsWorkflow):
```ts
const { result } = await createPromotionsWorkflow(container)
@@ -166,7 +166,7 @@ For most use cases, it's recommended to use [workflows](#using-workflows) instea
If you're managing promotions using the Promotion Module's service, you can specify rules for the promotion or its [application method](../application-method/page.mdx) in its methods.
For example, if you're creating a promotion with the [createPromotions](!resources!/references/promotion/createPromotions) method:
For example, if you're creating a promotion with the [createPromotions](/references/promotion/createPromotions) method:
```ts
const promotions = await promotionModuleService.createPromotions([
@@ -97,7 +97,7 @@ Read-only links are used to query data across modules, but the relations aren't
[SalesChannel](/references/sales-channel/models/SalesChannel)
</Table.Cell>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
[StockLocation](/references/stock-location-next/models/StockLocation) in [Stock Location Module](../../stock-location/page.mdx)
</Table.Cell>
<Table.Cell>
Stored - many-to-many
@@ -41,7 +41,7 @@ Read-only links are used to query data across modules, but the relations aren't
[FulfillmentSet](/references/fulfillment/models/FulfillmentSet) in [Fulfillment Module](../../fulfillment/page.mdx)
</Table.Cell>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation)
[StockLocation](/references/stock-location-next/models/StockLocation)
</Table.Cell>
<Table.Cell>
Stored - many-to-one
@@ -55,7 +55,7 @@ Read-only links are used to query data across modules, but the relations aren't
[FulfillmentProvider](/references/fulfillment/models/FulfillmentProvider) in [Fulfillment Module](../../fulfillment/page.mdx)
</Table.Cell>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation)
[StockLocation](/references/stock-location-next/models/StockLocation)
</Table.Cell>
<Table.Cell>
Stored - many-to-many
@@ -66,10 +66,10 @@ Read-only links are used to query data across modules, but the relations aren't
</Table.Row>
<Table.Row>
<Table.Cell>
[InventoryLevel](/references/inventory/models/InventoryLevel) in [Inventory Module](../../inventory/page.mdx)
[InventoryLevel](/references/inventory-next/models/InventoryLevel) in [Inventory Module](../../inventory/page.mdx)
</Table.Cell>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation)
[StockLocation](/references/stock-location-next/models/StockLocation)
</Table.Cell>
<Table.Cell>
Read-only - has many
@@ -83,7 +83,7 @@ Read-only links are used to query data across modules, but the relations aren't
[SalesChannel](/references/sales-channel/models/SalesChannel) in [Sales Channel Module](../../sales-channel/page.mdx)
</Table.Cell>
<Table.Cell>
[StockLocation](/references/stock-location/models/StockLocation)
[StockLocation](/references/stock-location-next/models/StockLocation)
</Table.Cell>
<Table.Cell>
Stored - many-to-many
@@ -59,7 +59,7 @@ Read-only links are used to query data across modules, but the relations aren't
The Store Module has a `Currency` data model that stores the supported currencies of a store. However, these currencies don't hold all the details of a currency, such as its name or symbol.
Instead, Medusa defines a read-only link between the [Currency Module](../../currency/page.mdx)'s `Currency` data model and the Store Module's `StoreCurrency` data model. This means you can retrieve the details of a store's supported currencies, but you don't manage the links in a pivot table in the database. The currencies of a store are determined by the `currency_code` of the [Currency](/references/store/models/Currency) data model in the Store Module (not in the Currency Module).
Instead, Medusa defines a read-only link between the [Currency Module](../../currency/page.mdx)'s `Currency` data model and the Store Module's `StoreCurrency` data model. This means you can retrieve the details of a store's supported currencies, but you don't manage the links in a pivot table in the database. The currencies of a store are determined by the `currency_code` of the [Currency](/references/store/models/StoreCurrency) data model in the Store Module (not in the Currency Module).
### Retrieve with Query
@@ -14,7 +14,7 @@ Refer to this [Medusa Admin User Guide](!user-guide!/settings/users) to learn ho
## Straightforward User Creation
To create a user, use the [create method of the User Module’s main service](/references/user/create):
To create a user, use the [createUsers method of the User Module’s main service](/references/user/createUsers):
```ts
const user = await userModuleService.createUsers({