bb87db8342
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.
39 lines
828 B
TypeScript
39 lines
828 B
TypeScript
import "../../globals.css"
|
|
import Navbar from "@/components/Navbar"
|
|
import Providers from "../../../providers"
|
|
import { WideLayout } from "docs-ui"
|
|
import { Inter, Roboto_Mono } from "next/font/google"
|
|
import clsx from "clsx"
|
|
|
|
export const metadata = {
|
|
title: "Medusa API Reference",
|
|
description: "Check out Medusa's API reference",
|
|
}
|
|
|
|
const inter = Inter({
|
|
subsets: ["latin"],
|
|
variable: "--font-inter",
|
|
weight: ["400", "500"],
|
|
})
|
|
|
|
const robotoMono = Roboto_Mono({
|
|
subsets: ["latin"],
|
|
variable: "--font-roboto-mono",
|
|
})
|
|
|
|
export default function RootLayout({
|
|
children,
|
|
}: {
|
|
children: React.ReactNode
|
|
}) {
|
|
return (
|
|
<WideLayout
|
|
ProvidersComponent={Providers}
|
|
NavbarComponent={Navbar}
|
|
bodyClassName={clsx(inter.variable, robotoMono.variable)}
|
|
>
|
|
{children}
|
|
</WideLayout>
|
|
)
|
|
}
|