docs: add notes + missing links for user guide (#11621)

* docs: add notes + missing links for user guide

* fix build errors

* fixes
This commit is contained in:
Shahed Nasser
2025-02-26 15:28:18 +02:00
committed by GitHub
parent 322d108c03
commit 95eef899f7
76 changed files with 736 additions and 794 deletions
@@ -107,8 +107,6 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add a link to cart object in API reference (once available). */}
The response of the Create Cart API route has a `cart` field, which is a cart object.
Refer to the [Create Cart API reference](!api!/store#carts_postcarts) for details on other available request parameters.
@@ -118,9 +118,7 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add a link to cart object in API reference (once available). */}
The response of the Retrieve Cart API route has a `cart` field, which is a cart object.
The response of the [Get Cart API](!api!/store#carts_getcartsid) route has a `cart` field, which is a cart object.
---
@@ -146,11 +146,7 @@ export const highlights = [
</CodeTab>
</CodeTabs>
The List Customer Addresses API route accepts pagination parameters to paginate the address.
{/* TODO add a link to the address object */}
It returns in the response the `addresses` field, which is an array of addresses.
The [List Customer Addresses API route](!api!/store#customers_getcustomersmeaddresses) accepts pagination parameters to paginate the address. It returns in the response the `addresses` field, which is an array of addresses.
---
@@ -142,6 +142,4 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add a link to product object in API reference (once available). */}
The response has a `products` field, which is an array of products.
The response has a `products` field, which is an array of [products](!api!/store#products_product_schema).
@@ -96,9 +96,7 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add link to product colleciton object */}
The response has a `collections` field, which is an array of product collections.
The response has a `collections` field, which is an array of [product collections](!api!/store#collections_getcollections).
---
@@ -144,6 +144,4 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add a link to product object in API reference (once available). */}
The response has a `products` field, which is an array of products.
The response has a `products` field, which is an array of [products](!api!/store#products_product_schema).
@@ -104,9 +104,7 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add link to product colleciton object */}
The response has a `collection` field, which is a product collection object.
The response has a `collection` field, which is a [product collection object](!api!/store#collections_collection_schema).
---
@@ -97,9 +97,7 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add a link to product object in API reference (once available). */}
The response has a `products` field, which is an array of products.
The response has a `products` field, which is an array of [products](!api!/store#products_product_schema).
---
@@ -121,9 +121,7 @@ export const highlights = [
</CodeTab>
</CodeTabs>
{/* TODO add a link to product object in API reference (once available). */}
The response has a `product` field, which is a product object.
The response has a `product` field, which is a [product object](!api!/store#products_product_schema).
---
@@ -24,9 +24,7 @@ Publishable API keys are associated with sales channels. Then, when the publisha
## How to Create a Publishable API Key?
{/* TODO replace link with admin how-to guide once available. */}
You create a publishable API key either using the Medusa Admin or the [Admin API routes](!api!/admin#api-keys_postapikeys).
You create a publishable API key either using the [Medusa Admin](!user-guide!/settings/developer/publishable-api-keys) or the [Admin API routes](!api!/admin#api-keys_postapikeys).
For example, using the [Create API Key API Route](!api!/admin#api-keys_postapikeys):