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.
52 lines
1.1 KiB
TypeScript
52 lines
1.1 KiB
TypeScript
"use client"
|
|
|
|
import {
|
|
Navbar as UiNavbar,
|
|
getNavbarItems,
|
|
usePageLoading,
|
|
useSidebar,
|
|
} from "docs-ui"
|
|
import FeedbackModal from "./FeedbackModal"
|
|
import { useMemo } from "react"
|
|
import { config } from "../../config"
|
|
import { usePathname } from "next/navigation"
|
|
import VersionSwitcher from "../VersionSwitcher"
|
|
|
|
const Navbar = () => {
|
|
const { setMobileSidebarOpen, mobileSidebarOpen } = useSidebar()
|
|
const pathname = usePathname()
|
|
const { isLoading } = usePageLoading()
|
|
|
|
const navbarItems = useMemo(
|
|
() =>
|
|
getNavbarItems({
|
|
basePath: config.baseUrl,
|
|
activePath: pathname,
|
|
}),
|
|
[pathname]
|
|
)
|
|
|
|
return (
|
|
<UiNavbar
|
|
logo={{
|
|
light: "/images/logo-icon.png",
|
|
dark: "/images/logo-icon-dark.png",
|
|
}}
|
|
items={navbarItems}
|
|
mobileMenuButton={{
|
|
setMobileSidebarOpen,
|
|
mobileSidebarOpen,
|
|
}}
|
|
additionalActionsBefore={
|
|
<>
|
|
{process.env.NEXT_PUBLIC_VERSIONING === "true" && <VersionSwitcher />}
|
|
</>
|
|
}
|
|
additionalActionsAfter={<FeedbackModal />}
|
|
isLoading={isLoading}
|
|
/>
|
|
)
|
|
}
|
|
|
|
export default Navbar
|