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

10
www/apps/docs/content/experimental/pricing/install-nodejs.md
View File

@@ -1,10 +1,10 @@
# Install in Node.js-Based Application
In this document, you’ll learn how to setup and use the Pricing module in a Node.js based application.
In this document, you’ll learn how to setup and use the Pricing Module in a Node.js based application.
## Prerequisites
Before installing the Pricing module in your application, make sure you have the following prerequisites:
Before installing the Pricing Module in your application, make sure you have the following prerequisites:
- Node.js v16 or greater
- PostgreSQL database. You can use an existing Medusa database, or set up a new PostgreSQL database.
@@ -13,7 +13,7 @@ Before installing the Pricing module in your application, make sure you have the
## Install Package
In your Node.js-based applications, such as a Next.js application, you can install the Pricing module with the following command:
In your Node.js-based applications, such as a Next.js application, you can install the Pricing Module with the following command:
```bash npm2yarn
npm install @medusajs/pricing
@@ -161,7 +161,7 @@ npm run price:seed
## Next.js Application: Adjust Configurations
The Pricing module uses dependencies that aren’t Webpack optimized. Since Next.js uses Webpack for compilation, you need to add the Pricing module as an external dependency.
The Pricing Module uses dependencies that aren’t Webpack optimized. Since Next.js uses Webpack for compilation, you need to add the Pricing Module as an external dependency.
To do that, add the `serverComponentsExternalPackages` option in `next.config.js`:
@@ -183,6 +183,6 @@ module.exports = nextConfig
## 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.