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:
@@ -0,0 +1,58 @@
|
||||
import React from "react"
|
||||
import { useLearningPath } from "../../../../providers/LearningPath"
|
||||
import { Button } from "docs-ui"
|
||||
import { ArrowDownLeftMini, ArrowDownMini } from "@medusajs/icons"
|
||||
|
||||
type LearningPathStepActionsType = {
|
||||
onFinish?: () => void
|
||||
onClose?: () => void
|
||||
setCollapsed: React.Dispatch<React.SetStateAction<boolean>>
|
||||
} & React.AllHTMLAttributes<HTMLDivElement>
|
||||
|
||||
export const LearningPathStepActions = ({
|
||||
onFinish,
|
||||
onClose,
|
||||
setCollapsed,
|
||||
}: LearningPathStepActionsType) => {
|
||||
const { hasNextStep, nextStep, endPath } = useLearningPath()
|
||||
|
||||
const handleFinish = () => {
|
||||
if (onFinish) {
|
||||
onFinish()
|
||||
} else {
|
||||
endPath()
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="flex p-docs_1 justify-between items-center">
|
||||
<div>
|
||||
<Button
|
||||
onClick={() => setCollapsed(true)}
|
||||
variant="secondary"
|
||||
className="!text-medusa-fg-subtle !p-[6px]"
|
||||
>
|
||||
<ArrowDownLeftMini className="flip-y hidden md:inline" />
|
||||
<ArrowDownMini className="inline md:hidden" />
|
||||
</Button>
|
||||
</div>
|
||||
<div className="flex gap-docs_0.5 items-center">
|
||||
{hasNextStep() && (
|
||||
<>
|
||||
<Button onClick={onClose} variant="secondary">
|
||||
Close
|
||||
</Button>
|
||||
<Button onClick={nextStep} variant="primary">
|
||||
Next
|
||||
</Button>
|
||||
</>
|
||||
)}
|
||||
{!hasNextStep() && (
|
||||
<Button onClick={handleFinish} variant="primary">
|
||||
Finish
|
||||
</Button>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
Reference in New Issue
Block a user