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:
@@ -2,7 +2,7 @@
|
||||
description: "In this document, you'll learn about the different ways you can configure the admin dashboard."
|
||||
---
|
||||
|
||||
import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Admin Configuration
|
||||
|
||||
@@ -37,7 +37,7 @@ const plugins = [
|
||||
]
|
||||
```
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
<TypeList types={[
|
||||
{
|
||||
name: "serve",
|
||||
type: "boolean",
|
||||
|
||||
@@ -8,7 +8,7 @@ In this guide, you’ll learn how to build the onboarding widget available in th
|
||||
|
||||
:::note
|
||||
|
||||
The onboarding widget is already implemented within the codebase of your Medusa backend. This guide is helpful if you want to understand how it was implemented or you want an example of customizing the Medusa admin and backend.
|
||||
The onboarding widget is already implemented within the codebase of your Medusa backend. This guide is helpful if you want to understand how it was implemented or you want an example of customizing the Medusa Admin and backend.
|
||||
|
||||
:::
|
||||
|
||||
@@ -1284,7 +1284,7 @@ Notice that as there are two types of flows, you'll be creating the components f
|
||||
{
|
||||
label: "@medusajs/product",
|
||||
language: "tsx",
|
||||
code: `// Install the Product module in a serverless project, such as a Next.js storefront: @medusajs/product\n\nimport {\ninitialize as initializeProductModule,\n} from "@medusajs/product"\n\n// in an async function, or you can use promises\nasync () => {\n // ...\n const productService = await initializeProductModule()\n const products = await productService.list({\n id: "${data?.product_id}",\n })\n\n console.log(products[0])\n}`,
|
||||
code: `// Install the Pricing Module in a serverless project, such as a Next.js storefront: @medusajs/product\n\nimport {\ninitialize as initializeProductModule,\n} from "@medusajs/product"\n\n// in an async function, or you can use promises\nasync () => {\n // ...\n const productService = await initializeProductModule()\n const products = await productService.list({\n id: "${data?.product_id}",\n })\n\n console.log(products[0])\n}`,
|
||||
},
|
||||
]} className="my-6">
|
||||
<CodeBlock.Header />
|
||||
|
||||
@@ -149,7 +149,7 @@ You can learn more about the admin dashboard and its features in the [User Guide
|
||||
|
||||
Medusa supports multiple languages and translations. Check out available languages [here](../user-guide/tips/languages.md).
|
||||
|
||||
Refer to [this user guide](../user-guide/users/profile.md#change-admin-language) to learn how to switch the language of the Medusa admin.
|
||||
Refer to [this user guide](../user-guide/users/profile.md#change-admin-language) to learn how to switch the language of the Medusa Admin.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user