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,9 +1,9 @@
import React from "react"
import { Badge, Link, Tooltip } from "@/components"
import { Badge, LegacyLink, Tooltip } from "@/components"
export type FeatureFlagNoticeProps = {
featureFlag: string
type?: "endpoint" | "parameter"
type?: "endpoint" | "type"
tooltipTextClassName?: string
badgeClassName?: string
badgeContent?: React.ReactNode
@@ -22,12 +22,13 @@ export const FeatureFlagNotice = ({
<span className={tooltipTextClassName}>
To use this {type}, make sure to
<br />
<Link
{/* TODO replace with Link once we move away from Docusaurus */}
<LegacyLink
href="https://docs.medusajs.com/development/feature-flags/toggle"
target="__blank"
>
enable its feature flag: <code>{featureFlag}</code>
</Link>
</LegacyLink>
</span>
}
clickable