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.
105 lines
1.8 KiB
TypeScript
105 lines
1.8 KiB
TypeScript
import { NavbarLinkProps } from "@/components"
|
|
import { OptionType } from "./hooks"
|
|
import { SidebarItemType } from "types"
|
|
|
|
export const GITHUB_ISSUES_PREFIX = `https://github.com/medusajs/medusa/issues/new?assignees=&labels=type%3A+docs&template=docs.yml`
|
|
export const GITHUB_UI_ISSUES_PREFIX = `https://github.com/medusajs/ui/issues/new?labels=documentation`
|
|
|
|
export const navbarItems: NavbarLinkProps[] = [
|
|
{
|
|
label: "Docs",
|
|
target: "_blank",
|
|
rel: "noreferrer",
|
|
href: `/`,
|
|
},
|
|
{
|
|
label: "User Guide",
|
|
target: "_blank",
|
|
rel: "noreferrer",
|
|
href: `/user-guide`,
|
|
},
|
|
{
|
|
label: "Store API",
|
|
target: "_blank",
|
|
rel: "noreferrer",
|
|
href: `/api/store`,
|
|
},
|
|
{
|
|
label: "Admin API",
|
|
target: "_blank",
|
|
rel: "noreferrer",
|
|
href: `/api/admin`,
|
|
},
|
|
{
|
|
label: "UI",
|
|
target: "_blank",
|
|
rel: "noreferrer",
|
|
href: `/ui`,
|
|
},
|
|
]
|
|
|
|
export const mobileSidebarItems: SidebarItemType[] = [
|
|
{
|
|
title: "Docs",
|
|
path: `/`,
|
|
loaded: true,
|
|
isPathHref: true,
|
|
},
|
|
{
|
|
title: "User Guide",
|
|
path: `/user-guide`,
|
|
loaded: true,
|
|
isPathHref: true,
|
|
},
|
|
{
|
|
title: "Store API",
|
|
path: `/api/store`,
|
|
loaded: true,
|
|
isPathHref: true,
|
|
},
|
|
{
|
|
title: "Admin API",
|
|
path: `/api/admin`,
|
|
loaded: true,
|
|
isPathHref: true,
|
|
},
|
|
{
|
|
title: "UI",
|
|
path: `/ui`,
|
|
loaded: true,
|
|
isPathHref: true,
|
|
},
|
|
]
|
|
|
|
// TODO add resources once we create index
|
|
export const searchFilters: OptionType[] = [
|
|
{
|
|
value: "admin",
|
|
label: "Admin API",
|
|
},
|
|
{
|
|
value: "store",
|
|
label: "Store API",
|
|
},
|
|
{
|
|
value: "docs",
|
|
label: "Docs",
|
|
},
|
|
{
|
|
value: "user-guide",
|
|
label: "User Guide",
|
|
},
|
|
{
|
|
value: "plugins",
|
|
label: "Plugins",
|
|
},
|
|
{
|
|
value: "reference",
|
|
label: "References",
|
|
},
|
|
{
|
|
value: "ui",
|
|
label: "UI",
|
|
},
|
|
]
|