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 07:47:35 +00:00
committed by GitHub
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions
+1 -4
View File
@@ -4,7 +4,6 @@ import {
ColorModeProvider,
MobileProvider,
ModalProvider,
NavbarProvider,
AnalyticsProvider,
ScrollControllerProvider,
} from "docs-ui"
@@ -23,9 +22,7 @@ const Providers = ({ children }: ProvidersProps) => {
<ModalProvider>
<ScrollControllerProvider scrollableSelector="#main">
<SidebarProvider>
<NavbarProvider basePath={process.env.NEXT_PUBLIC_BASE_PATH}>
<SearchProvider>{children}</SearchProvider>
</NavbarProvider>
<SearchProvider>{children}</SearchProvider>
</SidebarProvider>
</ScrollControllerProvider>
</ModalProvider>
+2 -30
View File
@@ -4,6 +4,7 @@ import {
AiAssistantCommandIcon,
AiAssistantProvider,
SearchProvider as UiSearchProvider,
searchFilters,
} from "docs-ui"
import { absoluteUrl } from "../lib/absolute-url"
@@ -33,36 +34,7 @@ const SearchProvider = ({ children }: SearchProviderProps) => {
},
],
checkInternalPattern: new RegExp(`^${absoluteUrl()}/ui`),
filterOptions: [
{
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",
},
],
filterOptions: searchFilters,
}}
initialDefaultFilters={["ui"]}
commands={[
+1
View File
@@ -15,6 +15,7 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => {
initialItems={docsConfig.sidebar}
shouldHandlePathChange={true}
scrollableElement={scrollableElement}
disableActiveTransition={true}
>
{children}
</UiSidebarProvider>