asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: prep for v2 documentation (#6710)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/modules/entities.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# entities
www/apps/docs/content/references/modules/file.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# file
www/apps/docs/content/references/modules/fulfillment.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# fulfillment
www/apps/docs/content/references/modules/inventory.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# inventory
www/apps/docs/content/references/modules/js_client.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# js-client
www/apps/docs/content/references/modules/medusa.mdx
+133 -133
View File
File diff suppressed because one or more lines are too long
www/apps/docs/content/references/modules/medusa_config.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# medusa-config
www/apps/docs/content/references/modules/medusa_react.mdx
+1 -1
View File
@@ -2,7 +2,7 @@
displayed_sidebar: medusaReactSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# medusa-react
www/apps/docs/content/references/modules/notification.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# notification
www/apps/docs/content/references/modules/payment.mdx
+3 -3
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# payment
@@ -21,8 +21,8 @@ ___
#### Parameters
<ParameterTypes parameters={[{"name":"obj","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="isPaymentProcessorError"/>
<TypeList types={[{"name":"obj","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="isPaymentProcessorError"/>
#### Returns
<ParameterTypes parameters={[{"name":"obj","type":"obj is PaymentProcessorError","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="isPaymentProcessorError"/>
<TypeList types={[{"name":"obj","type":"obj is PaymentProcessorError","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="isPaymentProcessorError"/>
www/apps/docs/content/references/modules/price_selection.mdx
+2 -2
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# price-selection
@@ -26,4 +26,4 @@ ___
#### Properties
<ParameterTypes parameters={[{"name":"DEFAULT","type":"[DEFAULT](medusa.mdx#default)","description":"","optional":false,"defaultValue":"\"default\"","expandable":false,"children":[]},{"name":"SALE","type":"[SALE](../medusa/enums/medusa.PriceListType.mdx#sale)","description":"","optional":false,"defaultValue":"\"sale\"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"[OVERRIDE](../medusa/enums/medusa.PriceListType.mdx#override)","description":"","optional":false,"defaultValue":"\"override\"","expandable":false,"children":[]}]} sectionTitle="PriceType"/>
<TypeList types={[{"name":"DEFAULT","type":"[DEFAULT](medusa.mdx#default)","description":"","optional":false,"defaultValue":"\"default\"","expandable":false,"children":[]},{"name":"SALE","type":"[SALE](../medusa/enums/medusa.PriceListType.mdx#sale)","description":"","optional":false,"defaultValue":"\"sale\"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"[OVERRIDE](../medusa/enums/medusa.PriceListType.mdx#override)","description":"","optional":false,"defaultValue":"\"override\"","expandable":false,"children":[]}]} sectionTitle="PriceType"/>
www/apps/docs/content/references/modules/pricing.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# pricing
www/apps/docs/content/references/modules/product.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# product
www/apps/docs/content/references/modules/search.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# search
www/apps/docs/content/references/modules/services.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# services
www/apps/docs/content/references/modules/stock_location.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# stock-location
www/apps/docs/content/references/modules/tax.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# tax
www/apps/docs/content/references/modules/tax_calculation.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# tax-calculation
www/apps/docs/content/references/modules/types.mdx
+1 -1
View File
@@ -1,4 +1,4 @@
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# types
www/apps/docs/content/references/modules/workflows.mdx
+1 -1
View File
@@ -3,7 +3,7 @@ displayed_sidebar: workflowsSidebar
slug: /references/workflows
---
import ParameterTypes from "@site/src/components/ParameterTypes"
import TypeList from "@site/src/components/TypeList"
# Workflows API Reference