Skip to content

Commit 857a26f

Browse files
shahednassershahednasser
authored
docs: improve links to other modules docs (medusajs#11868)
1 parent cae47d9 commit 857a26f

File tree

17 files changed

+15317
-14179
lines changed

17 files changed

+15317
-14179
lines changed

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

Lines changed: 14018 additions & 13988 deletions
Large diffs are not rendered by default.

‎www/apps/resources/app/commerce-modules/api-key/links-to-other-modules/page.mdx‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CodeTabs, CodeTab } from "docs-ui"
1+
import { CodeTabs, CodeTab, Table } from "docs-ui"
22

33
export const metadata = {
44
title: `Links between API Key Module and Other Modules`,
@@ -12,7 +12,40 @@ This document showcases the module links defined between the API Key Module and
1212

1313
The API Key Module has the following links to other modules:
1414

15-
- [`ApiKey` data model \<\> `SalesChannel` data model of Sales Channel Module](#sales-channel-module).
15+
<Table>
16+
<Table.Header>
17+
<Table.Row>
18+
<Table.HeaderCell>
19+
First Data Model
20+
</Table.HeaderCell>
21+
<Table.HeaderCell>
22+
Second Data Model
23+
</Table.HeaderCell>
24+
<Table.HeaderCell>
25+
Type
26+
</Table.HeaderCell>
27+
<Table.HeaderCell>
28+
Description
29+
</Table.HeaderCell>
30+
</Table.Row>
31+
</Table.Header>
32+
<Table.Body>
33+
<Table.Row>
34+
<Table.Cell>
35+
[ApiKey](/references/api-key/models/ApiKey)
36+
</Table.Cell>
37+
<Table.Cell>
38+
[SalesChannel](/references/sales-channel/models/SalesChannel) in [Sales Channel Module](../../sales-channel/page.mdx)
39+
</Table.Cell>
40+
<Table.Cell>
41+
Stored
42+
</Table.Cell>
43+
<Table.Cell>
44+
[Learn more](#sales-channel-module)
45+
</Table.Cell>
46+
</Table.Row>
47+
</Table.Body>
48+
</Table>
1649

1750
---
1851

‎www/apps/resources/app/commerce-modules/cart/links-to-other-modules/page.mdx‎

Lines changed: 135 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CodeTabs, CodeTab } from "docs-ui"
1+
import { CodeTabs, CodeTab, Table } from "docs-ui"
22

33
export const metadata = {
44
title: `Links between Cart Module and Other Modules`,
@@ -18,14 +18,140 @@ Read-only links are used to query data across modules, but the relations aren't
1818

1919
</Note>
2020

21-
- [`Cart` data model \<\> `Customer` data model of Customer Module](#customer-module). (Read-only).
22-
- [`Order` data model of Order Module \<\> `Cart` data model](#order-module).
23-
- [`Cart` data model \<\> `PaymentCollection` data model of Payment Module](#payment-module).
24-
- [`LineItem` data model \<\> `Product` data model of Product Module](#product-module). (Read-only).
25-
- [`LineItem` data model \<\> `ProductVariant` data model of Product Module](#product-module). (Read-only).
26-
- [`Cart` data model \<\> `Promotion` data model of Promotion Module](#promotion-module).
27-
- [`Cart` data model \<\> `Region` data model of Region Module](#region-module). (Read-only).
28-
- [`Cart` data model \<\> `SalesChannel` data model of Sales Channel Module](#sales-channel-module). (Read-only).
21+
<Table>
22+
<Table.Header>
23+
<Table.Row>
24+
<Table.HeaderCell>
25+
First Data Model
26+
</Table.HeaderCell>
27+
<Table.HeaderCell>
28+
Second Data Model
29+
</Table.HeaderCell>
30+
<Table.HeaderCell>
31+
Type
32+
</Table.HeaderCell>
33+
<Table.HeaderCell>
34+
Description
35+
</Table.HeaderCell>
36+
</Table.Row>
37+
</Table.Header>
38+
<Table.Body>
39+
<Table.Row>
40+
<Table.Cell>
41+
[Cart](/references/cart/models/Cart)
42+
</Table.Cell>
43+
<Table.Cell>
44+
[Customer](/references/customer/models/Customer) in [Customer Module](../../customer/page.mdx)
45+
</Table.Cell>
46+
<Table.Cell>
47+
Read-only
48+
</Table.Cell>
49+
<Table.Cell>
50+
[Learn more](#customer-module)
51+
</Table.Cell>
52+
</Table.Row>
53+
<Table.Row>
54+
<Table.Cell>
55+
[Order](/references/order/models/Order) in [Order Module](../../order/page.mdx)
56+
</Table.Cell>
57+
<Table.Cell>
58+
[Cart](/references/cart/models/Cart)
59+
</Table.Cell>
60+
<Table.Cell>
61+
Stored
62+
</Table.Cell>
63+
<Table.Cell>
64+
[Learn more](#order-module)
65+
</Table.Cell>
66+
</Table.Row>
67+
<Table.Row>
68+
<Table.Cell>
69+
[Cart](/references/cart/models/Cart)
70+
</Table.Cell>
71+
<Table.Cell>
72+
[PaymentCollection](/references/payment/models/PaymentCollection) in [Payment Module](../../payment/page.mdx)
73+
</Table.Cell>
74+
<Table.Cell>
75+
Stored
76+
</Table.Cell>
77+
<Table.Cell>
78+
[Learn more](#payment-module)
79+
</Table.Cell>
80+
</Table.Row>
81+
<Table.Row>
82+
<Table.Cell>
83+
[LineItem](/references/cart/models/LineItem)
84+
</Table.Cell>
85+
<Table.Cell>
86+
[Product](/references/product/models/Product) in [Product Module](../../product/page.mdx)
87+
</Table.Cell>
88+
<Table.Cell>
89+
Read-only
90+
</Table.Cell>
91+
<Table.Cell>
92+
[Learn more](#product-module)
93+
</Table.Cell>
94+
</Table.Row>
95+
<Table.Row>
96+
<Table.Cell>
97+
[LineItem](/references/cart/models/LineItem)
98+
</Table.Cell>
99+
<Table.Cell>
100+
[ProductVariant](/references/product/models/ProductVariant) in [Product Module](../../product/page.mdx)
101+
</Table.Cell>
102+
<Table.Cell>
103+
Read-only
104+
</Table.Cell>
105+
<Table.Cell>
106+
[Learn more](#product-module)
107+
</Table.Cell>
108+
</Table.Row>
109+
<Table.Row>
110+
<Table.Cell>
111+
[Cart](/references/cart/models/Cart)
112+
</Table.Cell>
113+
<Table.Cell>
114+
[Promotion](/references/promotion/models/Promotion) in [Promotion Module](../../promotion/page.mdx)
115+
</Table.Cell>
116+
<Table.Cell>
117+
Stored
118+
</Table.Cell>
119+
<Table.Cell>
120+
[Learn more](#promotion-module)
121+
</Table.Cell>
122+
</Table.Row>
123+
<Table.Row>
124+
<Table.Cell>
125+
[Cart](/references/cart/models/Cart)
126+
</Table.Cell>
127+
<Table.Cell>
128+
[Region](/references/region/models/Region) in [Region Module](../../region/page.mdx)
129+
</Table.Cell>
130+
<Table.Cell>
131+
Read-only
132+
</Table.Cell>
133+
<Table.Cell>
134+
[Learn more](#region-module)
135+
</Table.Cell>
136+
</Table.Row>
137+
<Table.Row>
138+
<Table.Cell>
139+
[Cart](/references/cart/models/Cart)
140+
</Table.Cell>
141+
<Table.Cell>
142+
[SalesChannel](/references/sales-channel/models/SalesChannel) in [Sales Channel Module](../../sales-channel/page.mdx)
143+
</Table.Cell>
144+
<Table.Cell>
145+
Read-only
146+
</Table.Cell>
147+
<Table.Cell>
148+
[Learn more](#sales-channel-module)
149+
</Table.Cell>
150+
</Table.Row>
151+
</Table.Body>
152+
</Table>
153+
154+
29155

30156
---
31157

‎www/apps/resources/app/commerce-modules/currency/links-to-other-modules/page.mdx‎

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { CodeTabs, CodeTab } from "docs-ui"
1+
import { CodeTabs, CodeTab, Table } from "docs-ui"
22

33
export const metadata = {
44
title: `Links between Currency Module and Other Modules`,
@@ -18,15 +18,47 @@ Read-only links are used to query data across modules, but the relations aren't
1818

1919
</Note>
2020

21-
- [`Currency` data model of Store Module \<\> `Currency` data model of Currency Module](#store-module). (Read-only).
22-
21+
<Table>
22+
<Table.Header>
23+
<Table.Row>
24+
<Table.HeaderCell>
25+
First Data Model
26+
</Table.HeaderCell>
27+
<Table.HeaderCell>
28+
Second Data Model
29+
</Table.HeaderCell>
30+
<Table.HeaderCell>
31+
Type
32+
</Table.HeaderCell>
33+
<Table.HeaderCell>
34+
Description
35+
</Table.HeaderCell>
36+
</Table.Row>
37+
</Table.Header>
38+
<Table.Body>
39+
<Table.Row>
40+
<Table.Cell>
41+
[Store](/references/store/models/Store) in [Store Module](../../store/page.mdx)
42+
</Table.Cell>
43+
<Table.Cell>
44+
[Currency](/references/currency/models/Currency)
45+
</Table.Cell>
46+
<Table.Cell>
47+
Read-only
48+
</Table.Cell>
49+
<Table.Cell>
50+
[Learn more](#store-module)
51+
</Table.Cell>
52+
</Table.Row>
53+
</Table.Body>
54+
</Table>
2355
---
2456

2557
## Store Module
2658

2759
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.
2860

29-
Instead, Medusa defines a read-only link between the Currency Module's `Currency` data model and the [Store Module](../../store/page.mdx)'s `Currency` 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` data model in the Store Module.
61+
Instead, Medusa defines a read-only link between the [Store Module](../../store/page.mdx)'s `Currency` data model and the Currency Module's `Currency` data model. Because the link is read-only from the `Store`'s side, you can only retrieve the details of a store's supported currencies, and not the other way around.
3062

3163
### Retrieve with Query
3264

0 commit comments

Comments
 (0)