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.

www/apps/docs/content/user-guide/customers/groups.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to manage customer groups on the Medusa admin. Learn how to create and edit customer groups.'
+description: 'This user guide explains how to manage customer groups on the Medusa Admin. Learn how to create and edit customer groups.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/customers/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage customers and customer groups.'
+description: 'Medusa Admin allows merchants to manage customers and customer groups.'
 ---
 
 # Customers Overview

www/apps/docs/content/user-guide/customers/manage.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage customers on the Medusa admin. Learn how to view and edit customers.'
+description: 'This user guide explains how to manage customers on the Medusa Admin. Learn how to view and edit customers.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/discounts/create.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to create a discount on the Medusa admin.'
+description: 'This user guide explains how to create a discount on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/discounts/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage discounts. Merchants can create discounts and manage their conditions.'
+description: 'Medusa Admin allows merchants to manage discounts. Merchants can create discounts and manage their conditions.'
 ---
 
 # Discounts Overview

www/apps/docs/content/user-guide/discounts/manage.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to manage discounts on the Medusa admin. Learn how to edit and delete discounts'
+description: 'This user guide explains how to manage discounts on the Medusa Admin. Learn how to edit and delete discounts'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/gift-cards/custom.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to manage custom gift cards on the Medusa admin. Learn how to create and edit custom gift cards.'
+description: 'This user guide explains how to manage custom gift cards on the Medusa Admin. Learn how to create and edit custom gift cards.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/gift-cards/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage gift cards. Merchants can manage main and custom gift cards.'
+description: 'Medusa Admin allows merchants to manage gift cards. Merchants can manage main and custom gift cards.'
 ---
 
 # Gift Cards Overview

www/apps/docs/content/user-guide/gift-cards/manage.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage the main gift card on the Medusa admin. Learn how to create, edit, and delete a gift card.'
+description: 'This user guide explains how to manage the main gift card on the Medusa Admin. Learn how to create, edit, and delete a gift card.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/multiwarehouse/index.md

@@ -1,11 +1,11 @@
 ---
 sidebar_position: 1
-description: "Multi-warehouse allows you to define multiple locations that your stock items are available in. In the Medusa admin, you can manage the store's inventory and location."
+description: "Multi-warehouse allows you to define multiple locations that your stock items are available in. In the Medusa Admin, you can manage the store's inventory and location."
 ---
 
 # Multi-Warehouse Overview
 
-In this document, you’ll get an overview of the multi-warehouse setup and how you can use it in the Medusa admin.
+In this document, you’ll get an overview of the multi-warehouse setup and how you can use it in the Medusa Admin.
 
 :::note
 

www/apps/docs/content/user-guide/multiwarehouse/locations.mdx

@@ -8,7 +8,7 @@ import UiIcon from '@site/src/components/UiIcon';
 
 # Manage Locations
 
-In this document, you’ll learn how to manage the stock locations using the Medusa admin.
+In this document, you’ll learn how to manage the stock locations using the Medusa Admin.
 
 ## Create a Location
 

www/apps/docs/content/user-guide/orders/drafts.mdx

@@ -12,7 +12,7 @@ In this document, you’ll learn more about draft orders, how to create them, an
 
 ## Overview
 
-Draft orders are orders created from the Medusa admin. Existing products or custom items can be added to the order as purchased items. You can also specify custom shipping amounts.
+Draft orders are orders created from the Medusa Admin. Existing products or custom items can be added to the order as purchased items. You can also specify custom shipping amounts.
 
 After a draft order is created and is marked as paid, an order will be created based on that draft order and it will appear as part of the Orders list.
 

www/apps/docs/content/user-guide/orders/edit.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 5
-description: 'This user guide explains how to edit the items in an order in the Medusa admin. You can add, update, replace, duplicate, and delete items.'
+description: 'This user guide explains how to edit the items in an order in the Medusa Admin. You can add, update, replace, duplicate, and delete items.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/orders/export.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 10
-description: 'This user guide explains how to export a list of orders on the Medusa admin.'
+description: 'This user guide explains how to export a list of orders on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/orders/index.md

@@ -12,7 +12,7 @@ In this document, you’ll get an overview of the orders listing page and everyt
 
 When customers buy one or more products, their order appears on the Orders page. You can view an order’s information, capture payment, create shipments and fulfillments, register returns or exchanges of the order, and more.
 
-The Orders domain also contains draft orders. Draft orders are orders that you create from the Medusa admin. After you fill out the order and mark it paid, it’s transformed into an order that appears as part of the Orders list.
+The Orders domain also contains draft orders. Draft orders are orders that you create from the Medusa Admin. After you fill out the order and mark it paid, it’s transformed into an order that appears as part of the Orders list.
 
 ---
 

www/apps/docs/content/user-guide/orders/payments.md

@@ -12,7 +12,7 @@ In this document, you’ll learn how to manage an order’s payment, including c
 
 When a customer places an order, using the payment provider they choose during checkout, they authorize the payment.
 
-The payment isn’t automatically captured. You must capture it manually from the Medusa admin.
+The payment isn’t automatically captured. You must capture it manually from the Medusa Admin.
 
 ---
 

www/apps/docs/content/user-guide/price-lists/_import.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to import prices to a price list on the Medusa admin.'
+description: 'This user guide explains how to import prices to a price list on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/price-lists/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage their price lists. Merchants can override prices or create sales using price lists.'
+description: 'Medusa Admin allows merchants to manage their price lists. Merchants can override prices or create sales using price lists.'
 ---
 
 # Price Lists Overview

www/apps/docs/content/user-guide/price-lists/manage.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage price lists on the Medusa admin. Learn how to create, edit, and delete price lists.'
+description: 'This user guide explains how to manage price lists on the Medusa Admin. Learn how to create, edit, and delete price lists.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/products/categories.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to manage categories on the Medusa admin. Learn how to create a category, edit existing categories, delete a category, and more.'
+description: 'This user guide explains how to manage categories on the Medusa Admin. Learn how to create a category, edit existing categories, delete a category, and more.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/products/collections.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-description: 'This user guide explains how to manage collections on the Medusa admin. Learn how to create, edit, and delete collections.'
+description: 'This user guide explains how to manage collections on the Medusa Admin. Learn how to create, edit, and delete collections.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/products/export.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 5
-description: 'This user guide explains how to export a list of products on the Medusa admin.'
+description: 'This user guide explains how to export a list of products on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/products/index.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage products. Merchants can view products and collections, edit them, and more.'
+description: 'Medusa Admin allows merchants to manage products. Merchants can view products and collections, edit them, and more.'
 ---
 
 import UiIcon from '@site/src/components/UiIcon';

www/apps/docs/content/user-guide/products/manage.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage products on the Medusa admin. Learn how to create a product, edit a product, and more.'
+description: 'This user guide explains how to manage products on the Medusa Admin. Learn how to create a product, edit a product, and more.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/regions/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage regions. Regions represent different countries within an ecommerce store.'
+description: 'Medusa Admin allows merchants to manage regions. Regions represent different countries within an ecommerce store.'
 ---
 
 # Regions Overview

www/apps/docs/content/user-guide/regions/manage.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage regions on the Medusa admin. Learn how to create and edit regions.'
+description: 'This user guide explains how to manage regions on the Medusa Admin. Learn how to create and edit regions.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/regions/providers.mdx

@@ -1,7 +1,7 @@
 ---
 sidebar_position: 3
 sidebar_label: Manage Providers
-description: 'This user guide explains how to manage payment and fulfillment providers in a region on the Medusa admin.'
+description: 'This user guide explains how to manage payment and fulfillment providers in a region on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/regions/shipping-options.mdx

@@ -1,7 +1,7 @@
 ---
 sidebar_position: 4
 sidebar_label: Manage Shipping Options
-description: 'This user guide explains how to manage shipping options in a region on the Medusa admin.'
+description: 'This user guide explains how to manage shipping options in a region on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/sales-channels/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage their sales channels. Merchants can separate products into multiple sales channels.'
+description: 'Medusa Admin allows merchants to manage their sales channels. Merchants can separate products into multiple sales channels.'
 ---
 
 # Sales Channels Overview
@@ -21,7 +21,7 @@ Sales channels are associated with data and settings in your ecommerce store.
 
 For each sales channel, you can choose which products belong to that sales channel. A product can be available in more than one sales channel.
 
-Then, when customers place an order from a sales channel, the order is associated with that sales channel. You’ll be able to see the sales channel an order was placed from in the Medusa admin.
+Then, when customers place an order from a sales channel, the order is associated with that sales channel. You’ll be able to see the sales channel an order was placed from in the Medusa Admin.
 
 ---
 

www/apps/docs/content/user-guide/sales-channels/manage.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage sales channels on the Medusa admin. Learn how to create, edit, and delete sales channels.'
+description: 'This user guide explains how to manage sales channels on the Medusa Admin. Learn how to create, edit, and delete sales channels.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/sales-channels/products.mdx

@@ -1,7 +1,7 @@
 ---
 sidebar_position: 3
 sidebar_label: Manage Products
-description: 'This user guide explains how to manage products in sales channels on the Medusa admin.'
+description: 'This user guide explains how to manage products in sales channels on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/settings/currencies.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage currencies on the Medusa admin. Learn how to add currencies and set default currency.'
+description: 'This user guide explains how to manage currencies on the Medusa Admin. Learn how to add currencies and set default currency.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/settings/publishable-api-keys.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-description: 'This user guide explains how to manage publishable API keys on the Medusa admin. Learn how to create, edit, copy, and revoke publishable API keys.'
+description: 'This user guide explains how to manage publishable API keys on the Medusa Admin. Learn how to create, edit, copy, and revoke publishable API keys.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/settings/return-reasons.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to manage return reasons on the Medusa admin. Learn how to add, edit, and remove return reasons.'
+description: 'This user guide explains how to manage return reasons on the Medusa Admin. Learn how to add, edit, and remove return reasons.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/settings/store.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'This user guide explains how to manage the store details on the Medusa admin.'
+description: 'This user guide explains how to manage the store details on the Medusa Admin.'
 ---
 
 # Manage Store Details

www/apps/docs/content/user-guide/taxes/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin allows merchants to manage their taxes. Merchants can specify and configure taxes per region.'
+description: 'Medusa Admin allows merchants to manage their taxes. Merchants can specify and configure taxes per region.'
 ---
 
 # Taxes Overview

www/apps/docs/content/user-guide/taxes/manage.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage taxes on the Medusa admin. Learn how to edit their configurations.'
+description: 'This user guide explains how to manage taxes on the Medusa Admin. Learn how to edit their configurations.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/taxes/tax-inclusive.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 5
-description: 'This user guide explains how to manage tax inclusive pricing on the Medusa admin.'
+description: 'This user guide explains how to manage tax inclusive pricing on the Medusa Admin.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/taxes/tax-overrides.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 4
-description: 'This user guide explains how to manage tax overrides on the Medusa admin. Learn how to add, edit, and delete overrides.'
+description: 'This user guide explains how to manage tax overrides on the Medusa Admin. Learn how to add, edit, and delete overrides.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/taxes/tax-rates.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to manage tax rates on the Medusa admin. Learn how to create, edit, and delete tax rates.'
+description: 'This user guide explains how to manage tax rates on the Medusa Admin. Learn how to create, edit, and delete tax rates.'
 addHowToData: true
 ---
 

www/apps/docs/content/user-guide/tips/bulk-editor.mdx

@@ -1,5 +1,5 @@
 ---
-description: "Learn how to use the bulk editor in the Medusa admin and its shortcuts. The bulk editor is available in different areas, including the product details page and the Create Price List form."
+description: "Learn how to use the bulk editor in the Medusa Admin and its shortcuts. The bulk editor is available in different areas, including the product details page and the Create Price List form."
 ---
 
 import getOsShortcut from '@site/src/utils/get-os-shortcut'
@@ -12,7 +12,7 @@ In this document, you'll learn about different tips and shortcuts to using the b
 
 The bulk editor allows you to edit prices or values using a spreadsheet-interface. It simplifies the editing process when working with a large number of data, and provides you with an intuitive user experience.
 
-The bulk editor is used in different areas of the Medusa admin, including the [Edit Product Prices](../products/manage.mdx#edit-product-prices) form or the [Create Price List](../price-lists/manage.mdx#step-3-edit-prices) form.
+The bulk editor is used in different areas of the Medusa Admin, including the [Edit Product Prices](../products/manage.mdx#edit-product-prices) form or the [Create Price List](../price-lists/manage.mdx#step-3-edit-prices) form.
 
 ---
 

www/apps/docs/content/user-guide/tips/lists.mdx

@@ -84,6 +84,6 @@ You can search for items in a list by clicking the <UiIcon lightIcon="https://re
 
 ## Multiple Pages
 
-Lists in the Medusa admin can span across multiple pages if the number of items in that list are more than 15. 
+Lists in the Medusa Admin can span across multiple pages if the number of items in that list are more than 15. 
 
 In that case, you can navigate between pages by clicking the arrows at the bottom of the list.

www/apps/docs/content/user-guide/users/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-description: 'Medusa admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa admin.'
+description: 'Medusa Admin can be accessed more than one user. Merchants can have users added into their team to use the Medusa Admin.'
 ---
 
 # Users Overview
@@ -9,7 +9,7 @@ In this document, you’ll get an overview of features related to users and team
 
 ## Overview
 
-Only users who are part of the store’s team can access the Medusa admin. You can have more than one user in a team. Each user must have an email and password to log in.
+Only users who are part of the store’s team can access the Medusa Admin. You can have more than one user in a team. Each user must have an email and password to log in.
 
 As an admin, you can manage the users’ roles and information. You can also invite or remove users.
 

www/apps/docs/content/user-guide/users/profile.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 2
-description: 'This user guide explains how to manage user profile on the Medusa admin. Learn how to edit a user profile and reset user password.'
+description: 'This user guide explains how to manage user profile on the Medusa Admin. Learn how to edit a user profile and reset user password.'
 addHowToData: true
 ---
 
@@ -38,7 +38,7 @@ To edit your profile details:
 
 ## Change Admin Language
 
-The Medusa admin supports multiple languages, and you can change the default language from your profile settings.
+The Medusa Admin supports multiple languages, and you can change the default language from your profile settings.
 
 :::note
 

www/apps/docs/content/user-guide/users/team.mdx

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-description: 'This user guide explains how to manage the team on the Medusa admin. Learn how to invite users to your team and edit their details.'
+description: 'This user guide explains how to manage the team on the Medusa Admin. Learn how to invite users to your team and edit their details.'
 addHowToData: true
 ---