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 09:47:35 +02:00
committed by GitHub
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions

View File

@@ -0,0 +1,53 @@
@tailwind base;
@tailwind components;
@tailwind utilities;
@layer base {
h1 {
@apply text-h1 mb-1;
}
h2 {
@apply text-h2 mb-1;
}
h3 {
@apply text-h3 mb-0.5;
}
h4 {
@apply text-h4 mb-0.5;
}
h1, h2, h3, h4 {
@apply text-medusa-fg-base;
}
hr {
@apply h-[1px] w-full border-0 bg-medusa-border-base my-2;
}
p, ul, ol {
@apply mb-1.5;
}
html {
-webkit-font-smoothing: antialiased;
}
body {
@apply overflow-x-hidden;
}
*::selection {
@apply bg-medusa-bg-highlight;
}
pre *::selection {
@apply !bg-medusa-code-text-highlight;
}
body[data-modal="opened"] {
@apply !overflow-hidden;
}
}