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
2024-03-18 07:47:35 +00:00
committed by GitHub
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions
@@ -12,7 +12,7 @@ In this document, youll 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.
@@ -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
---
@@ -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
---
@@ -12,7 +12,7 @@ In this document, youll 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 orders 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, its 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, its transformed into an order that appears as part of the Orders list.
---
@@ -12,7 +12,7 @@ In this document, youll learn how to manage an orders payment, including c
When a customer places an order, using the payment provider they choose during checkout, they authorize the payment.
The payment isnt automatically captured. You must capture it manually from the Medusa admin.
The payment isnt automatically captured. You must capture it manually from the Medusa Admin.
---