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.
26 lines
566 B
TypeScript
26 lines
566 B
TypeScript
"use client"
|
|
|
|
import { capitalize } from "docs-ui"
|
|
import { useArea } from "../../providers/area"
|
|
import { useVersion } from "../../providers/version"
|
|
|
|
type PageHeadingProps = {
|
|
className?: string
|
|
}
|
|
|
|
const PageHeading = ({ className }: PageHeadingProps) => {
|
|
const { area } = useArea()
|
|
const { version } = useVersion()
|
|
|
|
const versionText =
|
|
process.env.NEXT_PUBLIC_VERSIONING === "true" ? ` V${version}` : ""
|
|
|
|
return (
|
|
<h1 className={className}>
|
|
Medusa{versionText} {capitalize(area)} API Reference
|
|
</h1>
|
|
)
|
|
}
|
|
|
|
export default PageHeading
|