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