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
+21 -1
View File
@@ -5,26 +5,39 @@ export * from "./Bordered"
export * from "./BorderedIcon"
export * from "./Button"
export * from "./Card"
export * from "./CardList"
export * from "./ChildDocs"
export * from "./CodeBlock"
export * from "./CodeMdx"
export * from "./CodeTabs"
export * from "./CodeTabs/Item"
export * from "./CopyButton"
export * from "./Details"
export * from "./Details/Summary"
export * from "./DetailsList"
export * from "./EditButton"
export * from "./ExpandableNotice"
export * from "./FeatureFlagNotice"
export * from "./Feedback"
export * from "./Feedback/Solutions"
export * from "./HooksLoader"
export * from "./Icons"
export * from "./InlineIcon"
export * from "./InlineThemeImage"
export * from "./InlineCode"
export * from "./Input/Text"
export * from "./Kbd"
export * from "./Label"
export * from "./LearningPath"
export * from "./LegacyCodeTabs"
export * from "./LegacyLink"
export * from "./Link"
export * from "./Loading"
export * from "./Loading/Dots"
export * from "./Loading/Spinner"
export * from "./MarkdownContent"
export * from "./MDXComponents"
export * from "./MermaidDiagram"
export * from "./Modal"
export * from "./Modal/Header"
export * from "./Modal/Footer"
@@ -36,10 +49,11 @@ export * from "./Navbar/Logo"
export * from "./Navbar/MobileMenu"
export * from "./Navbar/MobileMenu/Button"
export * from "./Navbar/SearchModalOpener"
export { Link as NextLink, type LinkProps as NextLinkProps } from "./NextLink"
export * from "./Note"
export * from "./Notification"
export * from "./Notification/Item"
export * from "./Notification/Item/Layout/Default"
export * from "./Pagination"
export * from "./Rating"
export * from "./Search"
export * from "./Search/EmptyQueryBoundary"
@@ -52,5 +66,11 @@ export * from "./Search/Suggestions/Item"
export * from "./Select"
export * from "./Sidebar"
export * from "./Sidebar/Item"
export * from "./Table"
export * from "./Tabs"
export * from "./TextArea"
export * from "./ThemeImage"
export * from "./Toggle"
export * from "./Tooltip"
export * from "./TypeList"
export * from "./ZoomImg"