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 09:47:35 +02: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

8
www/apps/docs/content/experimental/pricing/install-medusa.mdx
View File

@@ -5,11 +5,11 @@ import TabItem from '@theme/TabItem';
# Install Pricing Module in Medusa
In this document, you'll learn how to install the Pricing module using NPM in the Medusa backend.
In this document, you'll learn how to install the Pricing Module using NPM in the Medusa backend.
## Step 1: Install Module
To install the Pricing module, run the following command in the root directory of the Medusa backend:
To install the Pricing Module, run the following command in the root directory of the Medusa backend:
```bash npm2yarn
npm install @medusajs/pricing
@@ -19,7 +19,7 @@ npm install @medusajs/pricing
## Step 2: Add Module to Configurations
In `medusa-config.js`, add the pricing module to the exported object under the `modules` property:
In `medusa-config.js`, add the Pricing Module to the exported object under the `modules` property:
```js title=medusa-config.js
module.exports = {
@@ -153,6 +153,6 @@ For example:
## Start Development
You can refer to the [Example Usages documentation page](./examples.mdx) for examples of using the Pricing module.
You can refer to the [Example Usages documentation page](./examples.mdx) for examples of using the Pricing Module.
You can also refer to the [Module Interface Reference](../../references/pricing/interfaces/pricing.IPricingModuleService.mdx) for a detailed reference on all available methods.