docs: prep for v2 documentation (#6710)
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
This commit is contained in:
Shahed Nasser
@@ -25,7 +25,7 @@ Medusa’s commerce features, including sales channels, customer groups, and pri
|
||||
|
||||
In Medusa, a sales channel allows you to set product availability per channel. In this case, you can create a B2B sales channel that will include only B2B products.
|
||||
|
||||
You can create a sales channel through the Medusa admin or Admin REST APIs.
|
||||
You can create a sales channel through the Medusa Admin or Admin REST APIs.
|
||||
|
||||
<DocCardList colSize={6} items={[
|
||||
{
|
||||
@@ -34,7 +34,7 @@ You can create a sales channel through the Medusa admin or Admin REST APIs.
|
||||
label: 'Option 1: Use Medusa Admin',
|
||||
customProps: {
|
||||
icon: Icons['users-solid'],
|
||||
description: 'Create the sales channel using the Medusa admin.',
|
||||
description: 'Create the sales channel using the Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -54,7 +54,7 @@ You can create a sales channel through the Medusa admin or Admin REST APIs.
|
||||
|
||||
Publishable API keys can be associated with one or more sales channels. Then, in a client such as a storefront, you can pass the publishable API key in the header of your requests to ensure all products retrieved belong to the associated sales channel(s).
|
||||
|
||||
You can create a publishable API key through the Medusa admin or the Admin REST APIs, then associate it with the B2B sales channel. You’ll later use this key when developing your B2B storefront.
|
||||
You can create a publishable API key through the Medusa Admin or the Admin REST APIs, then associate it with the B2B sales channel. You’ll later use this key when developing your B2B storefront.
|
||||
|
||||
<DocCardList colSize={6} items={[
|
||||
{
|
||||
@@ -63,7 +63,7 @@ You can create a publishable API key through the Medusa admin or the Admin REST
|
||||
label: 'Option 1: Use Medusa Admin',
|
||||
customProps: {
|
||||
icon: Icons['users-solid'],
|
||||
description: 'Create the publishable API key using the Medusa admin.',
|
||||
description: 'Create the publishable API key using the Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -81,7 +81,7 @@ You can create a publishable API key through the Medusa admin or the Admin REST
|
||||
|
||||
## Add Products
|
||||
|
||||
Using the Medusa admin or the Admin REST APIs, you can add your B2B products to your store. You can also import your products from an existing CSV file using the Product Import feature.
|
||||
Using the Medusa Admin or the Admin REST APIs, you can add your B2B products to your store. You can also import your products from an existing CSV file using the Product Import feature.
|
||||
|
||||
After or while you add your products, set the products’ availability to the B2B sales channel you’ve created.
|
||||
|
||||
@@ -92,7 +92,7 @@ After or while you add your products, set the products’ availability to the B2
|
||||
label: 'Add Products Using Medusa Admin',
|
||||
customProps: {
|
||||
icon: Icons['users-solid'],
|
||||
description: 'Create the product using the Medusa admin.',
|
||||
description: 'Create the product using the Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -110,7 +110,7 @@ After or while you add your products, set the products’ availability to the B2
|
||||
label: 'Import Products Using Medusa Admin',
|
||||
customProps: {
|
||||
icon: Icons['users-solid'],
|
||||
description: 'Import the products using the Medusa admin.',
|
||||
description: 'Import the products using the Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -143,7 +143,7 @@ For more advanced customer modeling, you may create custom entities. This is cov
|
||||
label: 'Option 1: Use Medusa Admin',
|
||||
customProps: {
|
||||
icon: Icons['users-solid'],
|
||||
description: 'Create the customer group using the Medusa admin.',
|
||||
description: 'Create the customer group using the Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -163,7 +163,7 @@ For more advanced customer modeling, you may create custom entities. This is cov
|
||||
|
||||
After adding your B2B customer group, you can add B2B customers and assign them to the B2B customer group. Alternatively, if you want to allow B2B customers to register themselves, then that will be covered in a later step.
|
||||
|
||||
You can create a customer through the Medusa admin or Admin REST APIs.
|
||||
You can create a customer through the Medusa Admin or Admin REST APIs.
|
||||
|
||||
<DocCardList colSize={6} items={[
|
||||
{
|
||||
@@ -172,7 +172,7 @@ You can create a customer through the Medusa admin or Admin REST APIs.
|
||||
label: 'Option 1: Use Medusa Admin',
|
||||
customProps: {
|
||||
icon: Icons['users-solid'],
|
||||
description: 'Create the customers using the Medusa admin.',
|
||||
description: 'Create the customers using the Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -194,7 +194,7 @@ A price list allows you to set different prices on a set of products for various
|
||||
|
||||
You can use price lists to set the same price for all B2B customers or different prices for different B2B customers if you’ve organized them into separate customer groups.
|
||||
|
||||
You can create a price list through the Medusa admin or Admin REST APIs.
|
||||
You can create a price list through the Medusa Admin or Admin REST APIs.
|
||||
|
||||
<DocCardList colSize={6} items={[
|
||||
{
|
||||
@@ -203,7 +203,7 @@ You can create a price list through the Medusa admin or Admin REST APIs.
|
||||
label: 'Add Price List Using Medusa Admin',
|
||||
customProps: {
|
||||
icon: Icons['users-solid'],
|
||||
description: 'Create the price list using the Medusa admin.',
|
||||
description: 'Create the price list using the Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -325,9 +325,9 @@ Medusa allows you to create custom API Routes exposed as REST APIs.
|
||||
|
||||
## Customize Admin
|
||||
|
||||
Based on your use case, you may need to customize the Medusa admin to add new widgets or pages.
|
||||
Based on your use case, you may need to customize the Medusa Admin to add new widgets or pages.
|
||||
|
||||
The Medusa admin plugin can be extended to add widgets, UI routes, and setting pages.
|
||||
The Medusa Admin plugin can be extended to add widgets, UI routes, and setting pages.
|
||||
|
||||
<DocCardList colSize={4} items={[
|
||||
{
|
||||
@@ -345,7 +345,7 @@ The Medusa admin plugin can be extended to add widgets, UI routes, and setting p
|
||||
label: 'Create Admin UI Routes',
|
||||
customProps: {
|
||||
icon: Icons['academic-cap-solid'],
|
||||
description: 'Learn how to add new pages to your Medusa admin.',
|
||||
description: 'Learn how to add new pages to your Medusa Admin.',
|
||||
}
|
||||
},
|
||||
{
|
||||
@@ -354,7 +354,7 @@ The Medusa admin plugin can be extended to add widgets, UI routes, and setting p
|
||||
label: 'Create Admin Setting Page',
|
||||
customProps: {
|
||||
icon: Icons['academic-cap-solid'],
|
||||
description: 'Learn how to add new page to the Medusa admin settings.',
|
||||
description: 'Learn how to add new page to the Medusa Admin settings.',
|
||||
}
|
||||
},
|
||||
]} />
|
||||
|
||||
Reference in New Issue
Block a user