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 09:47:35 +02:00
committed by GitHub
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions
@@ -0,0 +1,64 @@
import React from "react"
import { Table as UiTable } from "@medusajs/ui"
import clsx from "clsx"
type RootProps = React.HTMLAttributes<HTMLTableElement>
const Root = ({ className, ...props }: RootProps) => {
return (
<UiTable
className={clsx(
className,
"table-fixed mb-docs_1",
"[&_pre_span]:!max-w-full [&_pre_span]:!break-words [&_pre_span]:!whitespace-break-spaces"
)}
{...props}
/>
)
}
type HeaderCellProps = React.HTMLAttributes<HTMLTableCellElement>
const HeaderCell = ({ className, ...props }: HeaderCellProps) => {
return (
<UiTable.HeaderCell
className={clsx(className, "text-left pr-docs_1.5 h-docs_3 break-words")}
{...props}
/>
)
}
type RowProps = React.HTMLAttributes<HTMLTableRowElement>
const Row = ({ className, ...props }: RowProps) => {
return (
<UiTable.Row
className={clsx(
className,
"[&_td:last-child]:pr-docs_1.5 [&_th:last-child]:pr-docs_1.5 [&_td:first-child]:pl-docs_1.5 [&_th:first-child]:pl-docs_1.5"
)}
{...props}
/>
)
}
type CellProps = React.HTMLAttributes<HTMLTableCellElement>
const Cell = ({ className, ...props }: CellProps) => {
return (
<UiTable.Cell
className={clsx(className, "pr-docs_1.5 h-docs_3 break-words")}
{...props}
/>
)
}
const Table = Object.assign(Root, {
Row,
Cell,
Header: UiTable.Header,
HeaderCell,
Body: UiTable.Body,
})
export { Table }