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
@@ -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.
---
@@ -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.