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:
@@ -1,5 +1,5 @@
|
||||
import React from "react"
|
||||
import { Badge, Link, Tooltip } from "@/components"
|
||||
import { Badge, LegacyLink, Tooltip } from "@/components"
|
||||
|
||||
export type ExpandableNoticeProps = {
|
||||
type: "request" | "method"
|
||||
@@ -20,8 +20,11 @@ export const ExpandableNotice = ({
|
||||
<>
|
||||
If this {type} accepts an <code>expand</code>{" "}
|
||||
{type === "request" ? "parameter" : "property or option"},
|
||||
<br /> this field can be <Link href={link}>expanded</Link> into an
|
||||
object.
|
||||
{/* TODO replace with Link once we move away from Docusaurus */}
|
||||
<br /> this field can be <LegacyLink href={link}>
|
||||
expanded
|
||||
</LegacyLink>{" "}
|
||||
into an object.
|
||||
</>
|
||||
}
|
||||
clickable
|
||||
|
||||
Reference in New Issue
Block a user