asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'develop' into docs/quote-management-guide

Browse Source
This commit is contained in:
Shahed Nasser
2025-03-10 08:35:03 +02:00
parent 992c2af58e bd4428c40e
commit 4c4f97c940
271 changed files with 52396 additions and 48964 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/admin-components/page.mdx
+2 -2
View File
@@ -16,7 +16,7 @@ Refer to the [Medusa UI documentation](!ui!) for a full list of components.
Use these components to set the layout of your UI route.
<ChildDocs showItems={["Layouts"]} onlyTopLevel={false} />
<ChildDocs showItems={["Layouts"]} onlyTopLevel={false} hideTitle />
---
@@ -24,4 +24,4 @@ Use these components to set the layout of your UI route.
Use these components in your widgets and UI routes.
<ChildDocs showItems={["Components"]} onlyTopLevel={false} />
<ChildDocs showItems={["Components"]} onlyTopLevel={false} hideTitle />
www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx
-107
View File
@@ -1,107 +0,0 @@
export const metadata = {
title: `Translate Medusa Admin`,
}
# {metadata.title}
The Medusa Admin supports multiple languages, with the default being English. In this documentation, you'll learn how to contribute to the community by translating the Medusa Admin to a language you're fluent in.
{/* vale docs.We = NO */}
You can contribute either by translating the admin to a new language, or fixing translations for existing languages. As we can't validate every language's translations, some translations may be incorrect. Your contribution is welcome to fix any translation errors you find.
{/* vale docs.We = YES */}
<Note>
Check out the translated languages either in the admin dashboard's settings or on [GitHub](https://github.com/medusajs/medusa/blob/develop/packages/admin/dashboard/src/i18n/languages.ts).
</Note>
---
## How to Contribute Translation
1. Clone the [Medusa monorepository](https://github.com/medusajs/medusa) to your local machine:
```bash
git clone https://github.com/medusajs/medusa.git
```
If you already have it cloned, make sure to pull the latest changes from the `develop` branch.
2. Install the monorepository's dependencies. Since it's a Yarn workspace, it's highly recommended to use yarn:
```bash
yarn install
```
3. Create a branch that you'll use to open the pull request later:
```bash
git checkout -b feat/translate-<LANGUAGE>
```
Where `<LANGUAGE>` is your language name. For example, `feat/translate-da`.
4. Translation files are under `packages/admin/dashboard/src/i18n/translations` as JSON files whose names are the ISO-2 name of the language.
- If you're adding a new language, copy the file `packages/admin/dashboard/src/i18n/translations/en.json` and paste it with the ISO-2 name for your language. For example, if you're adding Danish translations, copy the `en.json` file and paste it as `packages/admin/dashboard/src/i18n/translations/de.json`.
- If you're fixing a translation, find the JSON file of the language under `packages/admin/dashboard/src/i18n/translations`.
5. Start translating the keys in the JSON file (or updating the targeted ones). All keys in the JSON file must be translated, and your PR tests will fail otherwise.
- You can check whether the JSON file is valid by running the following command in `packages/admin/dashboard`, replacing `da.json` with the JSON file's name:
```bash title="packages/admin/dashboard"
yarn i18n:validate da.json
```
6. After finishing the translation, if you're adding a new language, import its JSON file in `packages/admin/dashboard/src/i18n/translations/index.ts` and add it to the exported object:
```ts title="packages/admin/dashboard/src/i18n/translations/index.ts" highlights={[["2"], ["6"], ["7"], ["8"]]}
// other imports...
import da from "./da.json"
export default {
// other languages...
da: {
translation: da,
},
}
```
The language's key in the object is the ISO-2 name of the language.
7. If you're adding a new language, add it to the file `packages/admin/dashboard/src/i18n/languages.ts`:
export const languageHighlights = [
["7", "code", "The ISO-2 name of the language."],
["8", "display_name", "The language's name to be displayed in the admin."],
["9", "ltr", "Whether the language supports a left-to-right layout."],
["10", "date_locale", "An instance of the locale imported from the [date-fns/locale](https://date-fns.org/) package."]
]
```ts title="packages/admin/dashboard/src/i18n/languages.ts" highlights={languageHighlights}
import { da } from "date-fns/locale"
// other imports...
export const languages: Language[] = [
// other languages...
{
code: "da",
display_name: "Danish",
ltr: true,
date_locale: da,
},
]
```
`languages` is an array having the following properties:
- `code`: The ISO-2 name of the language. For example, `da` for Danish.
- `display_name`: The language's name to be displayed in the admin.
- `ltr`: Whether the language supports a left-to-right layout. For example, set this to `false` for languages like Arabic.
- `date_locale`: An instance of the locale imported from the [date-fns/locale](https://date-fns.org/) package.
8. Once you're done, push the changes into your branch and open a pull request on GitHub.
Our team will perform a general review on your PR and merge it if no issues are found. The translation will be available in the admin after the next release.
www/apps/resources/app/contribution-guidelines/docs/page.mdx
-259
View File
@@ -1,259 +0,0 @@
export const metadata = {
title: `Docs Contribution Guidelines`,
}
# {metadata.title}
Thank you for your interest in contributing to the documentation! You will be helping the open source community and other developers interested in learning more about Medusa and using it.
<Note title="Tip">
This guide is specific to contributing to the documentation. If you’re interested in contributing to Medusa’s codebase, check out the [contributing guidelines in the Medusa GitHub repository](https://github.com/medusajs/medusa/blob/develop/CONTRIBUTING.md).
</Note>
## Documentation Workspace
Medusa's documentation projects are all part of the documentation yarn workspace, which you can find in the [medusa repository](https://github.com/medusajs/medusa) under the `www` directory.
The workspace has the following two directories:
- `apps`: this directory holds the different documentation websites and projects.
- `book`: includes the codebase for the [main Medusa documentation](https://docs.medusajs.com/). It's built with [Next.js 15](https://nextjs.org/).
- `resources`: includes the codebase for the Medusa Development Resources documentation. It's built with [Next.js 15](https://nextjs.org/).
- `api-reference`: includes the codebase for the API reference website. It's built with [Next.js 15](https://nextjs.org/).
- `ui`: includes the codebase for the Medusa UI documentation website. It's built with [Next.js 15](https://nextjs.org/).
- `packages`: this directory holds the shared packages and components necessary for the development of the projects in the `apps` directory.
- `docs-ui` includes the shared React components between the different apps.
- `remark-rehype-plugins` includes Remark and Rehype plugins used by the documentation projects.
---
## Documentation Content
All documentation projects are built with Next.js. The content is writtin in MDX files.
### Medusa Main Docs Content
The content of the Medusa main docs are under the `www/apps/book/app` directory.
### Medusa Development Resources Content
The content of the Medusa Resources documentation are under the `www/apps/resources/app` directory.
<Note>
Documentation pages under the `www/apps/resources/references` directory are generated automatically from the source code under the `packages/medusa` directory. So, you can't directly make changes to them. Instead, you'll have to make changes to the comments in the original source code.
</Note>
### API Reference
The API reference's content is split into two types:
1. Static content, which are the content related to getting started, expanding fields, and more. These are located in the `www/apps/api-reference/markdown` directory. They are MDX files.
2. OpenAPI specs that are shown to developers when checking the reference of an API Route. These are generated from OpenApi Spec comments, which are under the `www/utils/generated/oas-output` directory.
### Medusa UI Documentation
The content of the Medusa UI documentation are located under the `www/apps/ui/src/content/docs` directory. They are MDX files.
The UI documentation also shows code examples, which are under the `www/apps/ui/src/examples` directory.
The UI component props are generated from the source code and placed into the `www/apps/ui/src/specs` directory. To contribute to these props and their comments, check the comments in the source code under the `packages/design-system/ui` directory.
---
## Style Guide
When you contribute to the documentation content, make sure to follow the [documentation style guide](https://www.notion.so/Style-Guide-Docs-fad86dd1c5f84b48b145e959f36628e0).
---
## How to Contribute
If you’re fixing errors in an existing documentation page, you can scroll down to the end of the page and click on the “Edit this page” link. You’ll be redirected to the GitHub edit form of that page and you can make edits directly and submit a pull request (PR).
If you’re adding a new page or contributing to the codebase, fork the repository, create a new branch, and make all changes necessary in your repository. Then, once you’re done, create a PR in the Medusa repository.
### Base Branch
When you make an edit to an existing documentation page or fork the repository to make changes to the documentation, create a new branch.
Documentation contributions always use `develop` as the base branch. Make sure to also open your PR against the `develop` branch.
### Branch Name
Make sure that the branch name starts with `docs/`. For example, `docs/fix-services`. Vercel deployed previews are only triggered for branches starting with `docs/`.
### Pull Request Conventions
When you create a pull request, prefix the title with `docs:` or `docs(PROJECT_NAME):`, where `PROJECT_NAME` is the name of the documentation project this pull request pertains to. For example, `docs(ui): fix titles`.
In the body of the PR, explain clearly what the PR does. If the PR solves an issue, use [closing keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) with the issue number. For example, “Closes #1333”.
---
## Images
If you are adding images to a documentation page, you can host the image on [Imgur](https://imgur.com) for free to include it in the PR. Our team will later upload it to our image hosting.
---
## NPM and Yarn Code Blocks
If you’re adding code blocks that use NPM and Yarn, you must add the `npm2yarn` meta field.
For example:
~~~md
```bash npm2yarn
npm run start
```
~~~
The code snippet must be written using NPM.
### Global Option
When a command uses the global option `-g`, add it at the end of the NPM command to ensure that it’s transformed to a Yarn command properly. For example:
```bash npm2yarn
npm install @medusajs/cli -g
```
---
## Linting with Vale
Medusa uses [Vale](https://vale.sh/) to lint documentation pages and perform checks on incoming PRs into the repository.
### Result of Vale PR Checks
You can check the result of running the "lint" action on your PR by clicking the Details link next to it. You can find there all errors that you need to fix.
### Run Vale Locally
If you want to check your work locally, you can do that by:
1. [Installing Vale](https://vale.sh/docs/vale-cli/installation/) on your machine.
2. Changing to the `www/vale` directory:
```bash
cd www/vale
```
3\. Running the `run-vale` script:
```bash
# to lint content for the main documentation
./run-vale.sh docs content error references
# to lint content for the API reference
./run-vale.sh api-reference app/_mdx error
# to lint content for the Medusa UI documentation
./run-vale.sh ui src/content/docs error
```
{/* TODO need to enable MDX v1 comments first. */}
{/* ### Linter Exceptions
If it's needed to break some style guide rules in a document, you can wrap the parts that the linter shouldn't scan with the following comments in the `md` or `mdx` files:
```md
<!-- vale off -->
content that shouldn't be scanned for errors here...
<!-- vale on -->
```
You can also disable specific rules. For example:
```md
<!-- vale docs.Numbers = NO -->
Medusa supports Node versions 14 and 16.
<!-- vale docs.Numbers = YES -->
```
If you use this in your PR, you must justify its usage. */}
---
## Linting with ESLint
Medusa uses ESlint to lint code blocks both in the content and the code base of the documentation apps.
### Linting Content with ESLint
Each PR runs through a check that lints the code in the content files using ESLint. The action's name is `content-eslint`.
If you want to check content ESLint errors locally and fix them, you can do that by:
1\. Install the dependencies in the `www` directory:
```bash
yarn install
```
2\. Run the turbo command in the `www` directory:
```bash
turbo run lint:content
```
This will fix any fixable errors, and show errors that require your action.
### Linting Code with ESLint
Each PR runs through a check that lints the code in the content files using ESLint. The action's name is `code-docs-eslint`.
If you want to check code ESLint errors locally and fix them, you can do that by:
1\. Install the dependencies in the `www` directory:
```bash
yarn install
```
2\. Run the turbo command in the `www` directory:
```bash
yarn lint
```
This will fix any fixable errors, and show errors that require your action.
{/* TODO need to enable MDX v1 comments first. */}
{/* ### ESLint Exceptions
If some code blocks have errors that can't or shouldn't be fixed, you can add the following command before the code block:
~~~md
<!-- eslint-skip -->
```js
console.log("This block isn't linted")
```
```js
console.log("This block is linted")
```
~~~
You can also disable specific rules. For example:
~~~md
<!-- eslint-disable semi -->
```js
console.log("This block can use semicolons");
```
```js
console.log("This block can't use semi colons")
```
~~~ */}
www/apps/resources/app/deployment/page.mdx
+1 -1
View File
@@ -24,7 +24,7 @@ With Medusa Cloud, you maintain full customization control as you deploy your ow
- Preview environments for new PRs.
- Test on production-like data.
[Sign up and learn more about Medusa Cloud](https://medusajs.com/contact)
[Sign up and learn more about Medusa Cloud](https://medusajs.com/pricing/)
---
www/apps/resources/app/layout.tsx
+1 -7
View File
@@ -63,13 +63,7 @@ export default function RootLayout({
htmlClassName={clsx(inter.variable, robotoMono.variable)}
gaId={process.env.NEXT_PUBLIC_GA_ID}
>
<TightLayout
sidebarProps={{
expandItems: true,
}}
ProvidersComponent={Providers}
footerComponent={<Footer />}
>
<TightLayout ProvidersComponent={Providers} footerComponent={<Footer />}>
{children}
</TightLayout>
</BareboneLayout>
www/apps/resources/app/recipes/page.mdx
+1 -1
View File
@@ -8,4 +8,4 @@ export const metadata = {
This section of the documentation provides recipes for common use cases with example implementations.
<ChildDocs onlyTopLevel />
<ChildDocs onlyTopLevel hideItems={["Overview"]} />
www/apps/resources/app/storefront-development/guides/express-checkout/page.mdx
-1
View File
@@ -1,7 +1,6 @@
---
tags:
- storefront
- js sdk
- cart
- product
- payment
www/apps/resources/app/storefront-development/page.mdx
+1 -1
View File
@@ -20,4 +20,4 @@ You can build your storefront from scratch, or built it on top of the [Next.js S
---
<ChildDocs hideItems={["General"]} />
<ChildDocs hideItems={["General", "Overview"]} />
www/apps/resources/app/troubleshooting/page.mdx
+1 -1
View File
@@ -12,4 +12,4 @@ The following troubleshooting guides are intended for technical users. If you're
</Note>
<ChildDocs />
<ChildDocs hideItems={["Overview"]} />
www/apps/resources/app/usage/page.mdx
-100
View File
@@ -1,100 +0,0 @@
export const metadata = {
title: `Usage Information`,
}
# {metadata.title}
At Medusa, we strive to provide the best experience for developers using our platform. For that reason, Medusa collects anonymous and non-sensitive data that provides a global understanding of how users are using Medusa.
---
## Purpose
As an open source solution, we work closely and constantly interact with our community to ensure that we provide the best experience for everyone using Medusa.
We are capable of getting a general understanding of how developers use Medusa and what general issues they run into through different means such as our Discord server, GitHub issues and discussions, and occasional one-on-one sessions.
However, although these methods can be insightful, they’re not enough to get a full and global understanding of how developers are using Medusa, especially in production.
Collecting this data allows us to understand certain details such as:
- What operating system do most Medusa developers use?
- What version of Medusa is widely used?
- What parts of the Medusa Admin are generally undiscovered by our users?
- How much data do users manage through our Medusa Admin? Is it being used for large number of products, orders, and other types of data?
- What Node version is globally used? Should we focus our efforts on providing support for versions that we don’t currently support?
---
## Medusa Application Analytics
This section covers which data in the Medusa application are collected and how to opt out of it.
### Collected Data in the Medusa Application
The following data is being collected on your Medusa application:
- Unique project ID generated with UUID.
- Unique machine ID generated with UUID.
- Operating system information including Node version or operating system platform used.
- The version of the Medusa application and Medusa CLI are used.
<Note>
Data is only collected when the Medusa application is run with the command `medusa start`.
</Note>
### How to Opt Out
If you prefer to disable data collection, you can do it either by setting the following environment variable to true:
```bash
MEDUSA_DISABLE_TELEMETRY=true
```
Or, you can run the following command in the root of your Medusa application project to disable it:
```bash
npx medusa telemetry --disable
```
---
## Admin Analytics
This section covers which data in the admin are collected and how to opt out of it.
### Collected Data in Admin
<Note>
Users have the option to [enable or disable the anonymization](#how-to-enable-anonymization) of the collected data.
</Note>
The following data is being collected on your admin:
- The name of the store.
- The email of the user.
- The total number of products, orders, discounts, and users.
- The number of regions and their names.
- The currencies used in the store.
- Errors that occur while using the admin.
### How to Enable Anonymization
To enable anonymization of your data from the Medusa Admin:
1. Go to Settings → Personal Information.
2. In the Usage insights section, click on the “Edit preferences” button.
3. Enable the "Anonymize my usage data” toggle.
4. Click on the “Submit and close” button.
### How to Opt-Out
To opt out of analytics collection in the Medusa Admin, set the following environment variable:
```bash
MEDUSA_FF_ANALYTICS=false
```
www/apps/resources/components/CommerceModuleSections/index.tsx
+6 -6
View File
@@ -12,7 +12,7 @@ export const CommerceModuleSections = () => {
showItems: ["Server Guides"],
defaultItemsPerRow: 2,
})
if (serverGuideItems?.default.length) {
if (serverGuideItems?.length) {
guideComponents.push(serverGuidesComponent)
}
const { items: storefrontGuideItems, component: storefrontGuidesComponent } =
@@ -20,7 +20,7 @@ export const CommerceModuleSections = () => {
showItems: ["Storefront Guides"],
defaultItemsPerRow: 2,
})
if (storefrontGuideItems?.default.length) {
if (storefrontGuideItems?.length) {
guideComponents.push(storefrontGuidesComponent)
}
const { items: adminGuideItems, component: adminGuidesComponent } =
@@ -28,7 +28,7 @@ export const CommerceModuleSections = () => {
showItems: ["Admin Guides"],
defaultItemsPerRow: 2,
})
if (adminGuideItems?.default.length) {
if (adminGuideItems?.length) {
guideComponents.push(adminGuidesComponent)
}
const { items: userGuideItems, component: userGuidesComponent } =
@@ -36,14 +36,14 @@ export const CommerceModuleSections = () => {
showItems: ["User Guides"],
defaultItemsPerRow: 2,
})
if (userGuideItems?.default.length) {
if (userGuideItems?.length) {
guideComponents.push(userGuidesComponent)
}
const { items: jsSdkItems, component: jsSdkComponent } = useChildDocs({
showItems: ["JS SDK"],
itemsPerRow: 2,
})
if (jsSdkItems?.default.length) {
if (jsSdkItems?.length) {
referenceComponents.push(jsSdkComponent)
}
const { items: referenceItems, component: referencesComponent } =
@@ -51,7 +51,7 @@ export const CommerceModuleSections = () => {
showItems: ["References"],
defaultItemsPerRow: 2,
})
if (referenceItems?.default.length) {
if (referenceItems?.length) {
referenceComponents.push(referencesComponent)
}
www/apps/resources/config/index.ts
+9 -7
View File
@@ -1,5 +1,5 @@
import { DocsConfig, SidebarItem } from "types"
import { generatedSidebar } from "../generated/sidebar.mjs"
import { DocsConfig, Sidebar } from "types"
import { generatedSidebars } from "../generated/sidebar.mjs"
import { globalConfig } from "docs-ui"
const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000"
@@ -9,16 +9,18 @@ export const config: DocsConfig = {
titleSuffix: "Medusa Development Resources",
baseUrl,
basePath: process.env.NEXT_PUBLIC_BASE_PATH,
sidebar: {
default: generatedSidebar as SidebarItem[],
mobile: [],
},
sidebars: generatedSidebars as Sidebar.Sidebar[],
project: {
title: "Development Resources",
key: "resources",
},
breadcrumbOptions: {
showCategories: true,
startItems: [
{
title: "Documentation",
link: baseUrl,
},
],
},
logo: `${process.env.NEXT_PUBLIC_BASE_PATH}/images/logo.png`,
}
www/apps/resources/generated/edit-dates.mjs
+3 -6
View File
@@ -99,7 +99,6 @@ export const generatedEditDates = {
"app/commerce-modules/user/user-creation-flows/page.mdx": "2025-02-26T11:35:54.685Z",
"app/commerce-modules/user/page.mdx": "2025-02-26T11:18:00.382Z",
"app/commerce-modules/page.mdx": "2024-12-23T14:38:21.064Z",
"app/contribution-guidelines/docs/page.mdx": "2024-12-12T11:06:12.250Z",
"app/create-medusa-app/page.mdx": "2025-01-16T10:00:25.975Z",
"app/deployment/admin/vercel/page.mdx": "2024-10-16T08:10:29.377Z",
"app/deployment/medusa-application/railway/page.mdx": "2025-02-24T07:35:43.421Z",
@@ -124,7 +123,7 @@ export const generatedEditDates = {
"app/recipes/pos/page.mdx": "2025-02-26T12:42:52.949Z",
"app/recipes/subscriptions/examples/standard/page.mdx": "2025-03-03T15:02:56.854Z",
"app/recipes/subscriptions/page.mdx": "2025-02-26T12:31:49.933Z",
"app/recipes/page.mdx": "2024-07-11T15:56:41+00:00",
"app/recipes/page.mdx": "2025-03-07T07:48:28.203Z",
"app/service-factory-reference/methods/create/page.mdx": "2024-07-31T17:01:33+03:00",
"app/service-factory-reference/methods/delete/page.mdx": "2024-07-31T17:01:33+03:00",
"app/service-factory-reference/methods/list/page.mdx": "2024-07-31T17:01:33+03:00",
@@ -178,7 +177,7 @@ export const generatedEditDates = {
"app/storefront-development/regions/store-retrieve-region/page.mdx": "2024-12-19T16:36:22.800Z",
"app/storefront-development/regions/page.mdx": "2024-06-09T15:19:09+02:00",
"app/storefront-development/tips/page.mdx": "2024-12-19T16:36:32.938Z",
"app/storefront-development/page.mdx": "2024-12-10T09:23:20.666Z",
"app/storefront-development/page.mdx": "2025-03-07T07:49:27.809Z",
"app/troubleshooting/cors-errors/page.mdx": "2024-05-03T17:36:38+03:00",
"app/troubleshooting/create-medusa-app-errors/page.mdx": "2024-07-11T10:29:13+03:00",
"app/troubleshooting/database-errors/page.mdx": "2024-05-03T17:36:38+03:00",
@@ -188,7 +187,6 @@ export const generatedEditDates = {
"app/troubleshooting/general-errors/page.mdx": "2024-05-03T17:36:38+03:00",
"app/troubleshooting/s3/page.mdx": "2025-01-24T13:47:24.994Z",
"app/troubleshooting/page.mdx": "2025-02-26T11:40:54.162Z",
"app/usage/page.mdx": "2025-02-26T11:49:39.213Z",
"app/page.mdx": "2025-02-26T10:23:58.440Z",
"app/commerce-modules/auth/_events/_events-table/page.mdx": "2024-07-03T19:27:13+03:00",
"app/commerce-modules/auth/auth-flows/page.mdx": "2025-01-13T11:31:35.361Z",
@@ -2103,7 +2101,7 @@ export const generatedEditDates = {
"app/admin-components/components/json-view-section/page.mdx": "2024-10-07T11:15:58.833Z",
"app/admin-components/components/section-row/page.mdx": "2024-10-07T11:15:58.832Z",
"app/admin-components/components/table/page.mdx": "2025-03-03T14:53:37.952Z",
"app/admin-components/page.mdx": "2024-10-07T11:09:49.493Z",
"app/admin-components/page.mdx": "2025-03-07T08:00:46.960Z",
"app/admin-components/layouts/single-column/page.mdx": "2024-10-07T11:16:06.435Z",
"app/admin-components/layouts/two-column/page.mdx": "2024-10-07T11:16:10.092Z",
"app/admin-components/components/forms/page.mdx": "2024-10-09T12:48:04.229Z",
@@ -3144,7 +3142,6 @@ export const generatedEditDates = {
"references/product/interfaces/product.FilterableProductProps/page.mdx": "2025-02-24T10:48:41.629Z",
"references/types/HttpTypes/interfaces/types.HttpTypes.AdminBatchProductVariantRequest/page.mdx": "2024-12-09T13:21:34.309Z",
"references/types/WorkflowTypes/ProductWorkflow/interfaces/types.WorkflowTypes.ProductWorkflow.ExportProductsDTO/page.mdx": "2025-02-11T11:36:51.281Z",
"app/contribution-guidelines/admin-translations/page.mdx": "2024-11-14T08:54:15.369Z",
"app/integrations/guides/sanity/page.mdx": "2025-03-05T10:58:58.807Z",
"references/api_key/types/api_key.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.715Z",
"references/auth/types/auth.FindConfigOrder/page.mdx": "2024-11-25T17:49:28.887Z",
www/apps/resources/generated/files-map.mjs
-12
View File
@@ -763,14 +763,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/commerce-modules/user/workflows/page.mdx",
"pathname": "/commerce-modules/user/workflows"
},
{
"filePath": "/www/apps/resources/app/contribution-guidelines/admin-translations/page.mdx",
"pathname": "/contribution-guidelines/admin-translations"
},
{
"filePath": "/www/apps/resources/app/contribution-guidelines/docs/page.mdx",
"pathname": "/contribution-guidelines/docs"
},
{
"filePath": "/www/apps/resources/app/create-medusa-app/page.mdx",
"pathname": "/create-medusa-app"
@@ -1271,10 +1263,6 @@ export const filesMap = [
"filePath": "/www/apps/resources/app/troubleshooting/workflow-errors/page.mdx",
"pathname": "/troubleshooting/workflow-errors"
},
{
"filePath": "/www/apps/resources/app/usage/page.mdx",
"pathname": "/usage"
},
{
"filePath": "/www/apps/resources/references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate/page.mdx",
"pathname": "/references/api_key/IApiKeyModuleService/methods/api_key.IApiKeyModuleService.authenticate"
www/apps/resources/generated/sidebar.mjs
+25033 -24440
View File
File diff suppressed because it is too large Load Diff
www/apps/resources/next.config.mjs
+10
View File
@@ -133,6 +133,16 @@ const nextConfig = {
destination: "/recipes/erp",
permanent: true,
},
{
source: "/contribution-guidelines/:path",
destination: `${process.env.NEXT_PUBLIC_BASE_URL}/learn/resources/contribution-guidelines/:path`,
permanent: true,
},
{
source: "/usage",
destination: `${process.env.NEXT_PUBLIC_BASE_URL}/learn/resources/usage`,
permanent: true,
},
]
},
outputFileTracingExcludes: {
www/apps/resources/providers/sidebar.tsx
+1 -6
View File
@@ -14,13 +14,8 @@ const SidebarProvider = ({ children }: SidebarProviderProps) => {
return (
<UiSidebarProvider
shouldHandlePathChange={true}
shouldHandleHashChange={false}
scrollableElement={scrollableElement}
initialItems={config.sidebar}
staticSidebarItems={true}
disableActiveTransition={true}
projectName="resources"
sidebars={config.sidebars}
>
{children}
</UiSidebarProvider>
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx
+1 -1
View File
@@ -4,7 +4,7 @@ sidebar_label: draftOrder
tags:
- js sdk
- admin
- draft order
- order
---
import { TypeList } from "docs-ui"
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.product/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.productCollection/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/js_sdk/admin/Product/methods/js_sdk.admin.Product.list/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/references/js_sdk/admin/ProductCollection/methods/js_sdk.admin.ProductCollection.list/page.mdx
+1 -1
View File
File diff suppressed because one or more lines are too long
www/apps/resources/scripts/prepare.mjs
+3 -3
View File
@@ -5,9 +5,9 @@ import { sidebar } from "../sidebar.mjs"
async function main() {
await generateSidebar(sidebar)
await generateSlugChanges()
await generateFilesMap()
await generateEditedDates()
// await generateSlugChanges()
// await generateFilesMap()
// await generateEditedDates()
}
void main()
www/apps/resources/sidebar.mjs
+134 -182
View File
@@ -24,219 +24,171 @@ import { storefrontGuidesSidebar } from "./sidebars/storefront.mjs"
import { taxSidebar } from "./sidebars/tax.mjs"
import { troubleshootingSidebar } from "./sidebars/troubleshooting.mjs"
import { userSidebar } from "./sidebars/user.mjs"
import { sidebarAttachHrefCommonOptions } from "./utils/sidebar-attach-common-options.mjs"
import { examplesSidebar } from "./sidebars/examples.mjs"
/** @type {import('types').RawSidebarItem[]} */
export const sidebar = sidebarAttachHrefCommonOptions([
/** @type {import("types").Sidebar.RawSidebar[]} */
export const sidebar = [
{
type: "link",
path: "/",
title: "Overview",
},
...examplesSidebar,
{
type: "link",
path: "/recipes",
title: "Recipes",
isChildSidebar: true,
children: recipesSidebar,
},
{
type: "separator",
},
{
type: "link",
path: "/commerce-modules",
title: "Commerce Modules",
hideChildren: true,
children: [
...apiKeySidebar,
...authSidebar,
...cartSidebar,
...currencySidebar,
...customerSidebar,
...fulfillmentSidebar,
...inventorySidebar,
...orderSidebar,
...paymentSidebar,
...pricingSidebar,
...productSidebar,
...promotionSidebar,
...regionSidebar,
...salesChannelSidebar,
...stockLocationSidebar,
...storeSidebar,
...taxSidebar,
...userSidebar,
],
},
{
type: "link",
path: "/architectural-modules",
title: "Architectural Modules",
isChildSidebar: true,
children: architecturalModulesSidebar,
},
{
type: "link",
path: "/integrations",
title: "Integrations",
isChildSidebar: true,
children: integrationsSidebar,
},
{
type: "ref",
path: "/plugins",
title: "Plugins",
isChildSidebar: true,
children: pluginsSidebar,
},
{
type: "link",
path: "/storefront-development",
title: "Storefront Development",
isChildSidebar: true,
children: storefrontGuidesSidebar,
},
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: sdkToolsSidebar,
},
{
type: "category",
title: "General",
children: [
sidebar_id: "resources",
title: "Development Resources",
items: [
{
type: "link",
path: "/references/medusa-config",
title: "Medusa Configurations",
path: "/",
title: "Overview",
},
...examplesSidebar,
...recipesSidebar,
{
type: "separator",
},
{
type: "link",
path: "/deployment",
title: "Deployment Guides",
isChildSidebar: true,
path: "/commerce-modules",
title: "Commerce Modules",
hideChildren: true,
sort_sidebar: "alphabetize",
children: [
...apiKeySidebar,
...authSidebar,
...cartSidebar,
...currencySidebar,
...customerSidebar,
...fulfillmentSidebar,
...inventorySidebar,
...orderSidebar,
...paymentSidebar,
...pricingSidebar,
...productSidebar,
...promotionSidebar,
...regionSidebar,
...salesChannelSidebar,
...stockLocationSidebar,
...storeSidebar,
...taxSidebar,
...userSidebar,
],
},
...architecturalModulesSidebar,
...integrationsSidebar,
...pluginsSidebar,
...storefrontGuidesSidebar,
{
type: "separator",
},
{
type: "category",
title: "SDKs and Tools",
children: sdkToolsSidebar,
},
{
type: "category",
title: "General",
children: [
{
type: "link",
title: "Medusa Cloud",
path: "https://medusajs.com/contact",
},
{
type: "separator",
},
{
type: "category",
title: "Self-Hosting",
type: "sidebar",
sidebar_id: "deployment-guides",
title: "Deployment Guides",
children: [
{
type: "link",
path: "https://docs.medusajs.com/learn/deployment/general",
title: "General",
path: "/deployment",
title: "Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/deployment/medusa-application/railway",
title: "Railway",
title: "Medusa Cloud",
path: "https://medusajs.com/pricing",
},
{
type: "separator",
},
{
type: "category",
title: "Self-Hosting",
children: [
{
type: "link",
path: "https://docs.medusajs.com/learn/deployment/general",
title: "General",
},
{
type: "link",
path: "/deployment/medusa-application/railway",
title: "Railway",
},
],
},
{
type: "category",
title: "Next.js Starter",
autogenerate_path: "/deployment/storefront",
},
],
},
{
type: "category",
title: "Next.js Starter",
autogenerate_path: "/deployment/storefront",
},
...troubleshootingSidebar,
],
},
{
type: "link",
path: "/troubleshooting",
title: "Troubleshooting Guides",
isChildSidebar: true,
children: troubleshootingSidebar,
},
],
},
{
type: "category",
title: "Admin",
children: [
{
type: "link",
path: "/admin-widget-injection-zones",
title: "Admin Widget Injection Zones",
},
{
type: "link",
path: "/admin-components",
title: "Admin Components",
isChildSidebar: true,
children: [
{
type: "category",
title: "Layouts",
autogenerate_path: "/admin-components/layouts",
},
{
type: "category",
title: "Components",
autogenerate_path: "/admin-components/components",
},
],
},
],
},
{
type: "category",
title: "Lists",
children: [
{
type: "link",
path: "/medusa-container-resources",
title: "Container Dependencies",
},
{
type: "link",
path: "/events-reference",
title: "Events List",
},
],
},
{
type: "category",
title: "References",
children: referencesSidebar,
},
{
type: "category",
title: "Other",
children: [
{
type: "sub-category",
title: "Contribution Guidelines",
type: "category",
title: "Admin",
children: [
{
type: "link",
path: "/contribution-guidelines/docs",
title: "Docs",
path: "/admin-widget-injection-zones",
title: "Admin Widget Injection Zones",
},
{
type: "link",
path: "/contribution-guidelines/admin-translations",
title: "Admin Translations",
type: "sidebar",
sidebar_id: "admin-components",
title: "Admin Components",
children: [
{
type: "link",
path: "/admin-components",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Layouts",
autogenerate_path: "/admin-components/layouts",
},
{
type: "category",
title: "Components",
autogenerate_path: "/admin-components/components",
},
],
},
],
},
{
type: "link",
path: "/usage",
title: "Usage",
type: "category",
title: "Lists",
children: [
{
type: "link",
path: "/medusa-container-resources",
title: "Container Dependencies",
},
{
type: "link",
path: "/events-reference",
title: "Events List",
},
],
},
{
type: "category",
title: "References",
children: referencesSidebar,
},
],
},
])
]
www/apps/resources/sidebars/api-key.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const apiKeySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "api-key",
title: "API Key Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -36,6 +36,7 @@ export const apiKeySidebar = [
autogenerate_tags: "server+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the API Key Module in your customizations on the Medusa application server.",
},
@@ -45,6 +46,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "storefront+apiKey,-jsSdk",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the API Key Module's features into your storefront.",
},
@@ -54,6 +56,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "admin+apiKey,-jsSdk",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the API Key Module.",
},
@@ -63,6 +66,7 @@ export const apiKeySidebar = [
initialOpen: false,
autogenerate_tags: "userGuide+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage API Key features in the Medusa Admin dashboard.",
},
@@ -84,12 +88,14 @@ export const apiKeySidebar = [
title: "Workflows",
autogenerate_tags: "workflow+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+apiKey",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -106,6 +112,7 @@ export const apiKeySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the API Key Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -114,6 +121,7 @@ export const apiKeySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,12 +131,19 @@ export const apiKeySidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/api-key",
type: "sidebar",
sidebar_id: "api-key-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "API Key Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/api-key",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -139,12 +154,19 @@ export const apiKeySidebar = [
],
},
{
type: "link",
path: "/references/api-key/models",
type: "sidebar",
sidebar_id: "api-key-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "API Key Module Data Models Reference",
children: [
{
type: "link",
path: "/references/api-key/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/architectural-modules.mjs
+129 -114
View File
@@ -1,161 +1,176 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const architecturalModulesSidebar = [
{
type: "category",
title: "Cache Modules",
type: "sidebar",
sidebar_id: "architectural-modules",
title: "Architectural Modules",
children: [
{
type: "link",
path: "/architectural-modules/cache",
path: "/architectural-modules",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/cache/in-memory",
title: "In-Memory",
type: "separator",
},
{
type: "link",
path: "/architectural-modules/cache/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Cache Modules",
children: [
{
type: "link",
path: "/architectural-modules/cache/create",
title: "Create Cache Module",
path: "/architectural-modules/cache",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/cache/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/cache/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/architectural-modules/cache/create",
title: "Create Cache Module",
},
],
},
],
},
],
},
{
type: "category",
title: "Event Modules",
children: [
{
type: "link",
path: "/architectural-modules/event",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/event/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/event/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Event Modules",
children: [
{
type: "link",
path: "/architectural-modules/event/create",
title: "Create Event Module",
path: "/architectural-modules/event",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/event/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/event/redis",
title: "Redis",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/architectural-modules/event/create",
title: "Create Event Module",
},
],
},
],
},
],
},
{
type: "category",
title: "File Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/file",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/file/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "File Module Providers",
children: [
{
type: "link",
path: "/references/file-provider-module",
title: "Create File Provider",
path: "/architectural-modules/file",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/file/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS S3 (and Compatible APIs)",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/references/file-provider-module",
title: "Create File Provider",
},
],
},
],
},
],
},
{
type: "category",
title: "Notification Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/notification",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/notification/local",
title: "Local",
},
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "sub-category",
title: "Guides",
type: "category",
title: "Notification Module Providers",
children: [
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
path: "/architectural-modules/notification",
title: "Overview",
},
{
type: "link",
path: "/references/notification-provider-module",
title: "Create Notification Provider",
path: "/architectural-modules/notification/local",
title: "Local",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Integrate Resend",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "sub-category",
title: "Guides",
children: [
{
type: "link",
path: "/references/notification-provider-module",
title: "Create Notification Provider",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Integrate Resend",
},
{
type: "link",
path: "/architectural-modules/notification/send-notification",
title: "Send Notification",
},
],
},
],
},
],
},
{
type: "category",
title: "Workflow Engine Modules",
children: [
{
type: "link",
path: "/architectural-modules/workflow-engine",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/redis",
title: "Redis",
type: "category",
title: "Workflow Engine Modules",
children: [
{
type: "link",
path: "/architectural-modules/workflow-engine",
title: "Overview",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/in-memory",
title: "In-Memory",
},
{
type: "link",
path: "/architectural-modules/workflow-engine/redis",
title: "Redis",
},
],
},
],
},
www/apps/resources/sidebars/auth.mjs
+30 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const authSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "auth",
title: "Auth Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -51,6 +51,7 @@ export const authSidebar = [
autogenerate_tags: "server+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Auth Module in your customizations on the Medusa application server.",
children: [
@@ -77,6 +78,7 @@ export const authSidebar = [
autogenerate_tags: "storefront+auth,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Auth Module's features into your storefront.",
},
@@ -86,6 +88,7 @@ export const authSidebar = [
autogenerate_tags: "admin+auth,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Auth Module.",
},
@@ -95,6 +98,7 @@ export const authSidebar = [
autogenerate_tags: "userGuide+auth",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Auth features in the Medusa Admin dashboard.",
},
@@ -138,12 +142,14 @@ export const authSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -154,6 +160,7 @@ export const authSidebar = [
hideChildren: true,
autogenerate_tags: "jsSdk+auth",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "link",
@@ -166,12 +173,19 @@ export const authSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/auth",
type: "sidebar",
sidebar_id: "auth-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Auth Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/auth",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -181,12 +195,19 @@ export const authSidebar = [
],
},
{
type: "link",
path: "/references/auth/models",
type: "sidebar",
sidebar_id: "auth-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Auth Module Data Models Reference",
children: [
{
type: "link",
path: "/references/auth/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/cart.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const cartSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "cart",
title: "Cart Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -46,6 +46,7 @@ export const cartSidebar = [
autogenerate_tags: "server+cart",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Cart Module in your customizations on the Medusa application server.",
children: [
@@ -62,6 +63,7 @@ export const cartSidebar = [
autogenerate_tags: "storefront+cart,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Cart Module's features into your storefront.",
},
@@ -71,6 +73,7 @@ export const cartSidebar = [
autogenerate_tags: "admin+cart,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Cart Module.",
},
@@ -80,6 +83,7 @@ export const cartSidebar = [
autogenerate_tags: "userGuide+cart",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Cart features in the Medusa Admin dashboard.",
},
@@ -101,12 +105,14 @@ export const cartSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+cart",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+cart",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,6 +129,7 @@ export const cartSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Cart Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -131,6 +138,7 @@ export const cartSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Cart Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -140,12 +148,19 @@ export const cartSidebar = [
title: "Events Reference",
},
{
type: "link",
path: "/references/cart",
type: "sidebar",
sidebar_id: "cart-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Cart Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/cart",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -155,12 +170,19 @@ export const cartSidebar = [
],
},
{
type: "link",
path: "/references/cart/models",
type: "sidebar",
sidebar_id: "cart-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Cart Module Data Models Reference",
children: [
{
type: "link",
path: "/references/cart/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/currency.mjs
+29 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const currencySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "currency",
title: "Currency Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -31,6 +31,7 @@ export const currencySidebar = [
autogenerate_tags: "server+currency",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Currency Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const currencySidebar = [
autogenerate_tags: "storefront+currency,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Currency Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const currencySidebar = [
autogenerate_tags: "admin+currency,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Currency Module.",
},
@@ -58,6 +61,7 @@ export const currencySidebar = [
autogenerate_tags: "userGuide+currency",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Currency features in the Medusa Admin dashboard.",
},
@@ -81,6 +85,7 @@ export const currencySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Currency Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -89,16 +94,24 @@ export const currencySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
{
type: "link",
path: "/references/currency",
type: "sidebar",
sidebar_id: "currency-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Currency Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/currency",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -108,12 +121,19 @@ export const currencySidebar = [
],
},
{
type: "link",
path: "/references/currency/models",
type: "sidebar",
sidebar_id: "currency-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Currency Module Data Models Reference",
children: [
{
type: "link",
path: "/references/currency/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/customer.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const customerSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "customer",
title: "Customer Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -36,6 +36,7 @@ export const customerSidebar = [
autogenerate_tags: "server+customer",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Customer Module in your customizations on the Medusa application server.",
children: [
@@ -52,6 +53,7 @@ export const customerSidebar = [
autogenerate_tags: "storefront+customer,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Customer Module's features into your storefront.",
},
@@ -61,6 +63,7 @@ export const customerSidebar = [
autogenerate_tags: "admin+customer,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Customer Module.",
},
@@ -70,6 +73,7 @@ export const customerSidebar = [
autogenerate_tags: "userGuide+customer",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Customer features in the Medusa Admin dashboard.",
},
@@ -91,12 +95,14 @@ export const customerSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+customer",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+customer",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -113,6 +119,7 @@ export const customerSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Customer Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -121,6 +128,7 @@ export const customerSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -135,12 +143,19 @@ export const customerSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/customer",
type: "sidebar",
sidebar_id: "customer-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Customer Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/customer",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -150,12 +165,19 @@ export const customerSidebar = [
],
},
{
type: "link",
path: "/references/customer/models",
type: "sidebar",
sidebar_id: "customer-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Customer Module Data Models Reference",
children: [
{
type: "link",
path: "/references/customer/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/examples.mjs
+7 -5
View File
@@ -1,13 +1,12 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const examplesSidebar = [
{
type: "link",
path: "/examples",
type: "sidebar",
sidebar_id: "examples",
title: "Examples",
isChildSidebar: true,
children: [
{
type: "ref",
type: "link",
path: "/examples",
title: "Example Snippets",
},
@@ -31,6 +30,7 @@ export const examplesSidebar = [
title: "Server Examples",
autogenerate_tags: "example+server",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [
{
type: "link",
@@ -49,6 +49,7 @@ export const examplesSidebar = [
title: "Admin Examples",
autogenerate_tags: "example+admin",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [],
},
{
@@ -56,6 +57,7 @@ export const examplesSidebar = [
title: "Storefront Examples",
autogenerate_tags: "example+storefront",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
children: [],
},
],
www/apps/resources/sidebars/fulfillment.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const fulfillmentSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "fulfillment",
title: "Fulfillment Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -58,6 +58,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "server+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Fulfillment Module in your customizations on the Medusa application server.",
children: [
@@ -79,6 +80,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "storefront+fulfillment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Fulfillment Module's features into your storefront.",
},
@@ -88,6 +90,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "admin+fulfillment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Fulfillment Module.",
},
@@ -97,6 +100,7 @@ export const fulfillmentSidebar = [
autogenerate_tags: "userGuide+fulfillment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.",
},
@@ -118,12 +122,14 @@ export const fulfillmentSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+fulfillment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+fulfillment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -140,6 +146,7 @@ export const fulfillmentSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -148,6 +155,7 @@ export const fulfillmentSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -162,12 +170,19 @@ export const fulfillmentSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/fulfillment",
type: "sidebar",
sidebar_id: "fulfillment-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Fulfillment Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/fulfillment",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -177,12 +192,19 @@ export const fulfillmentSidebar = [
],
},
{
type: "link",
path: "/references/fulfillment/models",
type: "sidebar",
sidebar_id: "fulfillment-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Fulfillment Module Data Models Reference",
children: [
{
type: "link",
path: "/references/fulfillment/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/integrations.mjs
+79 -64
View File
@@ -1,78 +1,93 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const integrationsSidebar = [
{
type: "category",
title: "Auth",
type: "sidebar",
sidebar_id: "integrations",
title: "Integrations",
children: [
{
type: "link",
path: "/commerce-modules/auth/auth-providers/google",
title: "Google",
path: "/integrations",
title: "Overview",
},
{
type: "link",
path: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
],
},
{
type: "category",
title: "CMS",
children: [
{
type: "link",
path: "/integrations/guides/sanity",
title: "Sanity",
},
],
},
{
type: "category",
title: "File",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS",
},
],
},
{
type: "category",
title: "Fulfillment",
children: [
{
type: "link",
path: "/integrations/guides/shipstation",
title: "ShipStation",
},
],
},
{
type: "category",
title: "Notification",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
type: "separator",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Resend",
type: "category",
title: "Auth",
children: [
{
type: "link",
path: "/commerce-modules/auth/auth-providers/google",
title: "Google",
},
{
type: "link",
path: "/commerce-modules/auth/auth-providers/github",
title: "GitHub",
},
],
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
type: "category",
title: "CMS",
children: [
{
type: "link",
path: "/integrations/guides/sanity",
title: "Sanity",
},
],
},
{
type: "category",
title: "File",
children: [
{
type: "link",
path: "/architectural-modules/file/s3",
title: "AWS",
},
],
},
{
type: "category",
title: "Fulfillment",
children: [
{
type: "link",
path: "/integrations/guides/shipstation",
title: "ShipStation",
},
],
},
{
type: "category",
title: "Notification",
children: [
{
type: "link",
path: "/architectural-modules/notification/sendgrid",
title: "SendGrid",
},
{
type: "link",
path: "/integrations/guides/resend",
title: "Resend",
},
],
},
{
type: "category",
title: "Payment",
children: [
{
type: "link",
path: "/commerce-modules/payment/payment-provider/stripe",
title: "Stripe",
},
],
},
],
},
www/apps/resources/sidebars/inventory.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const inventorySidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "inventory",
title: "Inventory Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -48,6 +48,7 @@ export const inventorySidebar = [
autogenerate_tags: "server+inventory",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Inventory Module in your customizations on the Medusa application server.",
},
@@ -57,6 +58,7 @@ export const inventorySidebar = [
autogenerate_tags: "storefront+inventory,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Inventory Module's features into your storefront.",
},
@@ -66,6 +68,7 @@ export const inventorySidebar = [
autogenerate_tags: "admin+inventory,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Inventory Module.",
},
@@ -75,6 +78,7 @@ export const inventorySidebar = [
autogenerate_tags: "userGuide+inventory",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.",
},
@@ -96,12 +100,14 @@ export const inventorySidebar = [
title: "Workflows",
autogenerate_tags: "workflow+inventory",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+inventory",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -118,6 +124,7 @@ export const inventorySidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -126,6 +133,7 @@ export const inventorySidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -135,12 +143,19 @@ export const inventorySidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/inventory-next",
type: "sidebar",
sidebar_id: "inventory-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Inventory Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/inventory-next",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -150,12 +165,19 @@ export const inventorySidebar = [
],
},
{
type: "link",
path: "/references/inventory-next/models",
type: "sidebar",
sidebar_id: "inventory-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Inventory Module Data Models Reference",
children: [
{
type: "link",
path: "/references/inventory-next/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/order-module.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const orderSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "order",
title: "Order Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -81,6 +81,7 @@ export const orderSidebar = [
autogenerate_tags: "server+order",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Order Module in your customizations on the Medusa application server.",
},
@@ -90,6 +91,7 @@ export const orderSidebar = [
autogenerate_tags: "storefront+order,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Order Module's features into your storefront.",
},
@@ -99,6 +101,7 @@ export const orderSidebar = [
autogenerate_tags: "admin+order,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Order Module.",
},
@@ -108,6 +111,7 @@ export const orderSidebar = [
autogenerate_tags: "userGuide+order",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Order features in the Medusa Admin dashboard.",
},
@@ -129,12 +133,14 @@ export const orderSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+order",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+order",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -151,6 +157,7 @@ export const orderSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Order Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -159,6 +166,7 @@ export const orderSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Order Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -173,12 +181,19 @@ export const orderSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/order",
type: "sidebar",
sidebar_id: "order-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Order Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/order",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -188,12 +203,19 @@ export const orderSidebar = [
],
},
{
type: "link",
path: "/references/order/models",
type: "sidebar",
sidebar_id: "order-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Order Module Data Models Reference",
children: [
{
type: "link",
path: "/references/order/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/payment.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const paymentSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "payment",
title: "Payment Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -66,6 +66,7 @@ export const paymentSidebar = [
autogenerate_tags: "server+payment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Payment Module in your customizations on the Medusa application server.",
children: [
@@ -87,6 +88,7 @@ export const paymentSidebar = [
autogenerate_tags: "storefront+payment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Payment Module's features into your storefront.",
},
@@ -96,6 +98,7 @@ export const paymentSidebar = [
autogenerate_tags: "admin+payment,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Payment Module.",
},
@@ -105,6 +108,7 @@ export const paymentSidebar = [
autogenerate_tags: "userGuide+payment",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Payment features in the Medusa Admin dashboard.",
},
@@ -138,12 +142,14 @@ export const paymentSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+payment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+payment",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -160,6 +166,7 @@ export const paymentSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Payment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -168,6 +175,7 @@ export const paymentSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -177,12 +185,19 @@ export const paymentSidebar = [
title: "Events Reference",
},
{
type: "link",
path: "/references/payment",
type: "sidebar",
sidebar_id: "payment-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Payment Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/payment",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -192,12 +207,19 @@ export const paymentSidebar = [
],
},
{
type: "link",
path: "/references/payment/models",
type: "sidebar",
sidebar_id: "payment-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Payment Module Data Models Reference",
children: [
{
type: "link",
path: "/references/payment/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/plugins.mjs
+18 -11
View File
@@ -1,19 +1,26 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const pluginsSidebar = [
{
type: "link",
title: "Overview",
path: "/plugins",
},
{
type: "category",
title: "Guides",
type: "sidebar",
sidebar_id: "plugins",
title: "Plugins",
children: [
{
type: "link",
title: "Wishlist",
path: "/plugins/guides/wishlist",
description: "Learn how to build a wishlist plugin.",
title: "Overview",
path: "/plugins",
},
{
type: "category",
title: "Guides",
children: [
{
type: "link",
title: "Wishlist",
path: "/plugins/guides/wishlist",
description: "Learn how to build a wishlist plugin.",
},
],
},
],
},
www/apps/resources/sidebars/pricing.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const pricingSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "pricing",
title: "Pricing Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -51,6 +51,7 @@ export const pricingSidebar = [
autogenerate_tags: "server+pricing",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Pricing Module in your customizations on the Medusa application server.",
},
@@ -60,6 +61,7 @@ export const pricingSidebar = [
autogenerate_tags: "storefront+pricing,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Pricing Module's features into your storefront.",
},
@@ -69,6 +71,7 @@ export const pricingSidebar = [
autogenerate_tags: "admin+pricing,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Pricing Module.",
},
@@ -78,6 +81,7 @@ export const pricingSidebar = [
autogenerate_tags: "userGuide+pricing",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.",
},
@@ -99,12 +103,14 @@ export const pricingSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+pricing",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+pricing",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -121,6 +127,7 @@ export const pricingSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -129,6 +136,7 @@ export const pricingSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -138,12 +146,19 @@ export const pricingSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/pricing",
type: "sidebar",
sidebar_id: "pricing-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Pricing Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/pricing",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -153,12 +168,19 @@ export const pricingSidebar = [
],
},
{
type: "link",
path: "/references/pricing/models",
type: "sidebar",
sidebar_id: "pricing-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Pricing Module Data Models Reference",
children: [
{
type: "link",
path: "/references/pricing/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/product.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const productSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "product",
title: "Product Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -43,6 +43,7 @@ export const productSidebar = [
autogenerate_tags: "server+product",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Product Module in your customizations on the Medusa application server.",
children: [
@@ -69,6 +70,7 @@ export const productSidebar = [
autogenerate_tags: "storefront+product,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Product Module's features into your storefront.",
},
@@ -78,6 +80,7 @@ export const productSidebar = [
autogenerate_tags: "admin+product,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Product Module.",
},
@@ -87,6 +90,7 @@ export const productSidebar = [
autogenerate_tags: "userGuide+product",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Product features in the Medusa Admin dashboard.",
},
@@ -108,12 +112,14 @@ export const productSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+product",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+product",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -130,6 +136,7 @@ export const productSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Product Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -138,6 +145,7 @@ export const productSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Product Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -152,12 +160,19 @@ export const productSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/product",
type: "sidebar",
sidebar_id: "product-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Product Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/product",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -167,12 +182,19 @@ export const productSidebar = [
],
},
{
type: "link",
path: "/references/product/models",
type: "sidebar",
sidebar_id: "product-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Product Module Data Models Reference",
children: [
{
type: "link",
path: "/references/product/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/promotion.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const promotionSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "promotion",
title: "Promotion Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -51,6 +51,7 @@ export const promotionSidebar = [
autogenerate_tags: "server+promotion",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Promotion Module in your customizations on the Medusa application server.",
children: [
@@ -67,6 +68,7 @@ export const promotionSidebar = [
autogenerate_tags: "storefront+promotion,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Promotion Module's features into your storefront.",
},
@@ -76,6 +78,7 @@ export const promotionSidebar = [
autogenerate_tags: "admin+promotion,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Promotion Module.",
},
@@ -85,6 +88,7 @@ export const promotionSidebar = [
autogenerate_tags: "userGuide+promotion",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.",
},
@@ -106,12 +110,14 @@ export const promotionSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+promotion",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+promotion",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -128,6 +134,7 @@ export const promotionSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -136,6 +143,7 @@ export const promotionSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -145,12 +153,19 @@ export const promotionSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/promotion",
type: "sidebar",
sidebar_id: "promotion-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Promotion Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/promotion",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -161,12 +176,19 @@ export const promotionSidebar = [
],
},
{
type: "link",
path: "/references/promotion/models",
type: "sidebar",
sidebar_id: "promotion-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Promotion Module Data Models Reference",
children: [
{
type: "link",
path: "/references/promotion/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/recipes.mjs
+94 -67
View File
@@ -1,55 +1,70 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const recipesSidebar = [
{
type: "link",
path: "/recipes/marketplace",
title: "Marketplace",
type: "sidebar",
sidebar_id: "recipes",
title: "Recipes",
children: [
{
type: "link",
path: "/recipes/marketplace/examples/vendors",
title: "Example: Vendors",
path: "/recipes",
title: "Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/recipes/marketplace/examples/restaurant-delivery",
title: "Example: Restaurant-Delivery",
path: "/recipes/marketplace",
title: "Marketplace",
children: [
{
type: "link",
path: "/recipes/marketplace/examples/vendors",
title: "Example: Vendors",
},
{
type: "link",
path: "/recipes/marketplace/examples/restaurant-delivery",
title: "Example: Restaurant-Delivery",
},
],
},
],
},
{
type: "link",
path: "/recipes/subscriptions",
title: "Subscriptions",
children: [
{
type: "link",
path: "/recipes/subscriptions/examples/standard",
title: "Example",
path: "/recipes/subscriptions",
title: "Subscriptions",
children: [
{
type: "link",
path: "/recipes/subscriptions/examples/standard",
title: "Example",
},
],
},
],
},
{
type: "link",
path: "/recipes/digital-products",
title: "Digital Products",
children: [
{
type: "link",
path: "/recipes/digital-products/examples/standard",
title: "Example",
path: "/recipes/digital-products",
title: "Digital Products",
children: [
{
type: "link",
path: "/recipes/digital-products/examples/standard",
title: "Example",
},
],
},
],
},
{
type: "link",
path: "/recipes/erp",
title: "Integrate ERP",
children: [
{
type: "link",
path: "/recipes/erp/odoo",
title: "Example: Odoo Integration",
path: "/recipes/erp",
title: "Integrate ERP",
children: [
{
type: "link",
path: "/recipes/erp/odoo",
title: "Example: Odoo Integration",
},
],
},
],
},
@@ -72,39 +87,51 @@ export const recipesSidebar = [
children: [
{
type: "link",
path: "/recipes/commerce-automation/restock-notification",
title: "Example: Restock Notifications",
path: "/recipes/b2b",
title: "B2B",
},
{
type: "link",
path: "/recipes/commerce-automation",
title: "Commerce Automation",
children: [
{
type: "link",
path: "/recipes/commerce-automation/restock-notification",
title: "Example: Restock Notifications",
},
],
},
{
type: "link",
path: "/recipes/ecommerce",
title: "Ecommerce",
},
{
type: "link",
path: "/recipes/multi-region-store",
title: "Multi-Region Store",
},
{
type: "link",
path: "/recipes/omnichannel",
title: "Omnichannel Store",
},
{
type: "link",
path: "/recipes/oms",
title: "OMS",
},
{
type: "link",
path: "/recipes/personalized-products",
title: "Personalized Products",
},
{
type: "link",
path: "/recipes/pos",
title: "POS",
},
],
},
{
type: "link",
path: "/recipes/ecommerce",
title: "Ecommerce",
},
{
type: "link",
path: "/recipes/multi-region-store",
title: "Multi-Region Store",
},
{
type: "link",
path: "/recipes/omnichannel",
title: "Omnichannel Store",
},
{
type: "link",
path: "/recipes/oms",
title: "OMS",
},
{
type: "link",
path: "/recipes/personalized-products",
title: "Personalized Products",
},
{
type: "link",
path: "/recipes/pos",
title: "POS",
},
]
www/apps/resources/sidebars/references.mjs
+60 -20
View File
@@ -1,12 +1,19 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const referencesSidebar = [
{
type: "link",
path: "/references/workflows",
type: "sidebar",
sidebar_id: "workflows-sdk-reference",
title: "Workflows SDK",
childSidebarTitle: "Workflows SDK Reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/references/workflows",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Functions",
@@ -15,12 +22,19 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/references/data-model",
type: "sidebar",
sidebar_id: "dml-reference",
title: "Data Model Language",
childSidebarTitle: "Data Model Language Reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/references/data-model",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "link",
path: "/references/data-model/define",
@@ -53,11 +67,18 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/service-factory-reference",
type: "sidebar",
sidebar_id: "service-factory-reference",
title: "Service Factory",
isChildSidebar: true,
children: [
{
type: "link",
path: "/service-factory-reference",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -71,25 +92,44 @@ export const referencesSidebar = [
],
},
{
type: "link",
path: "/references/helper-steps",
type: "sidebar",
sidebar_id: "helper-steps-reference",
title: "Helper Steps",
isChildSidebar: true,
autogenerate_path: "/references/helper_steps/functions",
children: [
{
type: "link",
path: "/references/helper-steps",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Steps",
autogenerate_path: "/references/helper_steps/functions",
},
],
},
{
type: "link",
type: "sidebar",
sidebar_id: "core-flows",
title: "Core Workflows",
path: "/medusa-workflows-reference",
isChildSidebar: true,
custom_autogenerate: "core-flows",
},
{
type: "link",
type: "sidebar",
sidebar_id: "test-tools-reference",
title: "Testing Framework",
path: "/test-tools-reference",
isChildSidebar: true,
children: [
{
type: "link",
path: "/test-tools-reference",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Functions",
www/apps/resources/sidebars/region.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const regionSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "region",
title: "Region Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -31,6 +31,7 @@ export const regionSidebar = [
autogenerate_tags: "server+region",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Region Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const regionSidebar = [
autogenerate_tags: "storefront+region,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Region Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const regionSidebar = [
autogenerate_tags: "admin+region,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Region Module.",
},
@@ -58,6 +61,7 @@ export const regionSidebar = [
autogenerate_tags: "userGuide+region",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Region features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const regionSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+region",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+region",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const regionSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Region Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const regionSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Region Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,12 +131,19 @@ export const regionSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/region",
type: "sidebar",
sidebar_id: "region-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Region Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/region",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -138,12 +153,19 @@ export const regionSidebar = [
],
},
{
type: "link",
path: "/references/region/models",
type: "sidebar",
sidebar_id: "region-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Region Module Data Models Reference",
children: [
{
type: "link",
path: "/references/region/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/sales-channel.mjs
+28 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const salesChannelSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "sales-channel",
title: "Sales Channel Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -38,6 +38,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "server+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Sales Channel Module in your customizations on the Medusa application server.",
},
@@ -47,6 +48,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "storefront+salesChannel,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Sales Channel Module's features into your storefront.",
},
@@ -56,6 +58,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "admin+salesChannel,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Sales Channel Module.",
},
@@ -65,6 +68,7 @@ export const salesChannelSidebar = [
autogenerate_tags: "userGuide+salesChannel",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.",
},
@@ -86,12 +90,14 @@ export const salesChannelSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+salesChannel",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+salesChannel",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -108,6 +114,7 @@ export const salesChannelSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Sales Channel Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -116,6 +123,7 @@ export const salesChannelSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -130,12 +138,16 @@ export const salesChannelSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/sales-channel",
type: "sidebar",
sidebar_id: "sales-channel-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Sales Channel Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/sales-channel",
title: "Reference Overview",
},
{
type: "category",
title: "Methods",
@@ -145,12 +157,19 @@ export const salesChannelSidebar = [
],
},
{
type: "link",
path: "/references/sales-channel/models",
type: "sidebar",
sidebar_id: "sales-channel-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Sales Channel Module Data Models Reference",
children: [
{
type: "link",
path: "/references/sales-channel/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/sdk-tools.mjs
+15 -10
View File
@@ -1,4 +1,4 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const sdkToolsSidebar = [
{
type: "link",
@@ -6,10 +6,9 @@ export const sdkToolsSidebar = [
title: "create-medusa-app",
},
{
type: "link",
path: "/medusa-cli",
type: "sidebar",
sidebar_id: "medusa-cli",
title: "Medusa CLI",
isChildSidebar: true,
childSidebarTitle: "Medusa CLI Reference",
children: [
{
@@ -28,12 +27,19 @@ export const sdkToolsSidebar = [
],
},
{
type: "link",
path: "/js-sdk",
type: "sidebar",
sidebar_id: "js-sdk",
title: "JS SDK",
isChildSidebar: true,
childSidebarTitle: "JS SDK Reference",
children: [
{
type: "link",
path: "/js-sdk",
title: "Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Auth",
@@ -55,10 +61,9 @@ export const sdkToolsSidebar = [
],
},
{
type: "link",
path: "/nextjs-starter",
type: "sidebar",
sidebar_id: "nextjs-starter",
title: "Next.js Starter Storefront",
isChildSidebar: true,
children: [
{
type: "link",
www/apps/resources/sidebars/stock-location.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const stockLocationSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "stock-location",
title: "Stock Location Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -38,6 +38,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "server+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Stock Location Module in your customizations on the Medusa application server.",
},
@@ -47,6 +48,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "storefront+stockLocation,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Stock Location Module's features into your storefront.",
},
@@ -56,6 +58,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "admin+stockLocation,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Stock Location Module.",
},
@@ -65,6 +68,7 @@ export const stockLocationSidebar = [
autogenerate_tags: "userGuide+stockLocation",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.",
},
@@ -86,12 +90,14 @@ export const stockLocationSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+stockLocation",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+stockLocation",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -108,6 +114,7 @@ export const stockLocationSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Stock Location Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -116,6 +123,7 @@ export const stockLocationSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -125,12 +133,19 @@ export const stockLocationSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/stock-location-next",
type: "sidebar",
sidebar_id: "stock-location-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Stock Location Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/stock-location-next",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -140,12 +155,19 @@ export const stockLocationSidebar = [
],
},
{
type: "link",
path: "/references/stock-location-next/models",
type: "sidebar",
sidebar_id: "stock-location-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Stock Location Module Data Models Reference",
children: [
{
type: "link",
path: "/references/stock-location-next/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/store.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const storeSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "store",
title: "Store Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -31,6 +31,7 @@ export const storeSidebar = [
autogenerate_tags: "server+store",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Store Module in your customizations on the Medusa application server.",
},
@@ -40,6 +41,7 @@ export const storeSidebar = [
autogenerate_tags: "storefront+store,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Store Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const storeSidebar = [
autogenerate_tags: "admin+store,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Store Module.",
},
@@ -58,6 +61,7 @@ export const storeSidebar = [
autogenerate_tags: "userGuide+store",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Store features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const storeSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+store",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+store",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const storeSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Store Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const storeSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Store Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -118,12 +126,19 @@ export const storeSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/store",
type: "sidebar",
sidebar_id: "store-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Store Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/store",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -133,12 +148,19 @@ export const storeSidebar = [
],
},
{
type: "link",
path: "/references/store/models",
type: "sidebar",
sidebar_id: "store-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Store Module Data Models Reference",
children: [
{
type: "link",
path: "/references/store/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/storefront.mjs
+240 -225
View File
@@ -1,259 +1,274 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const storefrontGuidesSidebar = [
{
type: "category",
title: "General",
type: "sidebar",
sidebar_id: "storefront-development",
title: "Storefront Development",
children: [
{
type: "link",
path: "/storefront-development/tips",
title: "Tips",
},
{
type: "link",
path: "/storefront-development/publishable-api-keys",
title: "Publishable API Key",
},
],
},
{
type: "category",
title: "Examples",
children: [
{
type: "link",
path: "/storefront-development/guides/express-checkout",
title: "Express Checkout Storefront",
},
],
},
{
type: "category",
title: "Regions",
children: [
{
type: "link",
path: "/storefront-development/regions",
path: "/storefront-development",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/regions/list",
title: "List Regions",
type: "separator",
},
{
type: "link",
path: "/storefront-development/regions/store-retrieve-region",
title: "Store and Retrieve Regions",
},
{
type: "link",
path: "/storefront-development/regions/context",
title: "Region React Context",
},
],
},
{
type: "category",
title: "Products",
children: [
{
type: "link",
path: "/storefront-development/products/list",
title: "List Products",
},
{
type: "link",
path: "/storefront-development/products/retrieve",
title: "Retrieve a Product",
},
{
type: "link",
path: "/storefront-development/products/variants",
title: "Select a Variant",
},
{
type: "link",
path: "/storefront-development/products/price",
title: "Retrieve Variant Prices",
autogenerate_path: "storefront-development/products/price/examples",
},
{
type: "link",
path: "/storefront-development/products/inventory",
title: "Retrieve Variant Inventory",
},
],
},
{
type: "category",
title: "Product Categories",
children: [
{
type: "link",
path: "/storefront-development/products/categories/list",
title: "List Categories",
},
{
type: "link",
path: "/storefront-development/products/categories/retrieve",
title: "Retrieve a Category",
},
{
type: "link",
path: "/storefront-development/products/categories/products",
title: "Retrieve a Category's Products",
},
{
type: "link",
path: "/storefront-development/products/categories/nested-categories",
title: "Retrieve Nested Categories",
},
],
},
{
type: "category",
title: "Product Collections",
children: [
{
type: "link",
path: "/storefront-development/products/collections/list",
title: "List Collections",
},
{
type: "link",
path: "/storefront-development/products/collections/retrieve",
title: "Retrieve a Collection",
},
{
type: "link",
path: "/storefront-development/products/collections/products",
title: "Retrieve a Collection's Products",
},
],
},
{
type: "category",
title: "Carts",
children: [
{
type: "link",
path: "/storefront-development/cart/create",
title: "Create Cart",
},
{
type: "link",
path: "/storefront-development/cart/retrieve",
title: "Retrieve Cart",
},
{
type: "link",
path: "/storefront-development/cart/context",
title: "Cart React Context",
},
{
type: "link",
path: "/storefront-development/cart/update",
title: "Update Cart",
},
{
type: "link",
path: "/storefront-development/cart/manage-items",
title: "Manage Line Items",
},
],
},
{
type: "category",
title: "Checkout",
children: [
{
type: "link",
path: "/storefront-development/checkout",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/checkout/email",
title: "1. Enter Email",
},
{
type: "link",
path: "/storefront-development/checkout/address",
title: "2. Set Address",
},
{
type: "link",
path: "/storefront-development/checkout/shipping",
title: "3. Choose Shipping Method",
},
{
type: "link",
path: "/storefront-development/checkout/payment",
title: "4. Choose Payment Provider",
type: "category",
title: "General",
children: [
{
type: "link",
path: "/storefront-development/checkout/payment/stripe",
title: "Example: Stripe",
path: "/storefront-development/tips",
title: "Tips",
},
{
type: "link",
path: "/storefront-development/publishable-api-keys",
title: "Publishable API Key",
},
],
},
{
type: "link",
path: "/storefront-development/checkout/complete-cart",
title: "5. Complete Cart",
},
],
},
{
type: "category",
title: "Customers",
children: [
{
type: "link",
path: "/storefront-development/customers/register",
title: "Register Customer",
type: "category",
title: "Examples",
children: [
{
type: "link",
path: "/storefront-development/guides/express-checkout",
title: "Express Checkout Storefront",
},
],
},
{
type: "link",
path: "/storefront-development/customers/login",
title: "Login Customer",
type: "category",
title: "Regions",
children: [
{
type: "link",
path: "/storefront-development/regions",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/regions/list",
title: "List Regions",
},
{
type: "link",
path: "/storefront-development/regions/store-retrieve-region",
title: "Store and Retrieve Regions",
},
{
type: "link",
path: "/storefront-development/regions/context",
title: "Region React Context",
},
],
},
{
type: "link",
path: "/storefront-development/customers/third-party-login",
title: "Third-Party (Social) Login",
type: "category",
title: "Products",
children: [
{
type: "link",
path: "/storefront-development/products/list",
title: "List Products",
},
{
type: "link",
path: "/storefront-development/products/retrieve",
title: "Retrieve a Product",
},
{
type: "link",
path: "/storefront-development/products/variants",
title: "Select a Variant",
},
{
type: "link",
path: "/storefront-development/products/price",
title: "Retrieve Variant Prices",
autogenerate_path: "storefront-development/products/price/examples",
},
{
type: "link",
path: "/storefront-development/products/inventory",
title: "Retrieve Variant Inventory",
},
],
},
{
type: "link",
path: "/storefront-development/customers/reset-password",
title: "Reset Password",
type: "category",
title: "Product Categories",
children: [
{
type: "link",
path: "/storefront-development/products/categories/list",
title: "List Categories",
},
{
type: "link",
path: "/storefront-development/products/categories/retrieve",
title: "Retrieve a Category",
},
{
type: "link",
path: "/storefront-development/products/categories/products",
title: "Retrieve a Category's Products",
},
{
type: "link",
path: "/storefront-development/products/categories/nested-categories",
title: "Retrieve Nested Categories",
},
],
},
{
type: "link",
path: "/storefront-development/customers/retrieve",
title: "Retrieve Customer",
type: "category",
title: "Product Collections",
children: [
{
type: "link",
path: "/storefront-development/products/collections/list",
title: "List Collections",
},
{
type: "link",
path: "/storefront-development/products/collections/retrieve",
title: "Retrieve a Collection",
},
{
type: "link",
path: "/storefront-development/products/collections/products",
title: "Retrieve a Collection's Products",
},
],
},
{
type: "link",
path: "/storefront-development/customers/context",
title: "Customer React Context",
type: "category",
title: "Carts",
children: [
{
type: "link",
path: "/storefront-development/cart/create",
title: "Create Cart",
},
{
type: "link",
path: "/storefront-development/cart/retrieve",
title: "Retrieve Cart",
},
{
type: "link",
path: "/storefront-development/cart/context",
title: "Cart React Context",
},
{
type: "link",
path: "/storefront-development/cart/update",
title: "Update Cart",
},
{
type: "link",
path: "/storefront-development/cart/manage-items",
title: "Manage Line Items",
},
],
},
{
type: "link",
path: "/storefront-development/customers/profile",
title: "Edit Customer Profile",
type: "category",
title: "Checkout",
children: [
{
type: "link",
path: "/storefront-development/checkout",
title: "Overview",
},
{
type: "link",
path: "/storefront-development/checkout/email",
title: "1. Enter Email",
},
{
type: "link",
path: "/storefront-development/checkout/address",
title: "2. Set Address",
},
{
type: "link",
path: "/storefront-development/checkout/shipping",
title: "3. Choose Shipping Method",
},
{
type: "link",
path: "/storefront-development/checkout/payment",
title: "4. Choose Payment Provider",
children: [
{
type: "link",
path: "/storefront-development/checkout/payment/stripe",
title: "Example: Stripe",
},
],
},
{
type: "link",
path: "/storefront-development/checkout/complete-cart",
title: "5. Complete Cart",
},
],
},
{
type: "link",
path: "/storefront-development/customers/addresses",
title: "Manage Customer Addresses",
},
{
type: "link",
path: "/storefront-development/customers/log-out",
title: "Log-out Customer",
type: "category",
title: "Customers",
children: [
{
type: "link",
path: "/storefront-development/customers/register",
title: "Register Customer",
},
{
type: "link",
path: "/storefront-development/customers/login",
title: "Login Customer",
},
{
type: "link",
path: "/storefront-development/customers/third-party-login",
title: "Third-Party (Social) Login",
},
{
type: "link",
path: "/storefront-development/customers/reset-password",
title: "Reset Password",
},
{
type: "link",
path: "/storefront-development/customers/retrieve",
title: "Retrieve Customer",
},
{
type: "link",
path: "/storefront-development/customers/context",
title: "Customer React Context",
},
{
type: "link",
path: "/storefront-development/customers/profile",
title: "Edit Customer Profile",
},
{
type: "link",
path: "/storefront-development/customers/addresses",
title: "Manage Customer Addresses",
},
{
type: "link",
path: "/storefront-development/customers/log-out",
title: "Log-out Customer",
},
],
},
],
},
www/apps/resources/sidebars/tax.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const taxSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "tax",
title: "Tax Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -46,6 +46,7 @@ export const taxSidebar = [
autogenerate_tags: "server+tax",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the Tax Module in your customizations on the Medusa application server.",
children: [
@@ -62,6 +63,7 @@ export const taxSidebar = [
autogenerate_tags: "storefront+tax,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the Tax Module's features into your storefront.",
},
@@ -71,6 +73,7 @@ export const taxSidebar = [
autogenerate_tags: "admin+tax,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the Tax Module.",
},
@@ -80,6 +83,7 @@ export const taxSidebar = [
autogenerate_tags: "userGuide+tax",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage Tax features in the Medusa Admin dashboard.",
},
@@ -101,12 +105,14 @@ export const taxSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+tax",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+tax",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,6 +129,7 @@ export const taxSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the Tax Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -131,6 +138,7 @@ export const taxSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -140,12 +148,19 @@ export const taxSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/tax",
type: "sidebar",
sidebar_id: "tax-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "Tax Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/tax",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -154,12 +169,19 @@ export const taxSidebar = [
],
},
{
type: "link",
path: "/references/tax/models",
type: "sidebar",
sidebar_id: "tax-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "Tax Module Data Models Reference",
children: [
{
type: "link",
path: "/references/tax/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/sidebars/troubleshooting.mjs
+92 -77
View File
@@ -1,99 +1,114 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const troubleshootingSidebar = [
{
type: "category",
title: "Installation",
type: "sidebar",
sidebar_id: "troubleshooting",
title: "Troubleshooting",
children: [
{
type: "link",
path: "/troubleshooting/create-medusa-app-errors",
title: "Create Medusa App Errors",
path: "/troubleshooting",
title: "Overview",
},
{
type: "link",
path: "/troubleshooting/errors-installing-cli",
title: "Errors Installing CLI",
type: "separator",
},
{
type: "link",
path: "/troubleshooting/general-errors",
title: "General Errors",
},
],
},
{
type: "category",
title: "Medusa Application",
children: [
{
type: "link",
path: "/troubleshooting/eaddrinuse",
title: "EADDRINUSE Error",
type: "category",
title: "Installation",
children: [
{
type: "link",
path: "/troubleshooting/create-medusa-app-errors",
title: "Create Medusa App Errors",
},
{
type: "link",
path: "/troubleshooting/errors-installing-cli",
title: "Errors Installing CLI",
},
{
type: "link",
path: "/troubleshooting/general-errors",
title: "General Errors",
},
],
},
{
type: "link",
path: "/troubleshooting/database-errors",
title: "Database Errors",
type: "category",
title: "Medusa Application",
children: [
{
type: "link",
path: "/troubleshooting/eaddrinuse",
title: "EADDRINUSE Error",
},
{
type: "link",
path: "/troubleshooting/database-errors",
title: "Database Errors",
},
{
type: "link",
path: "/troubleshooting/dist-imports",
title: "Importing from /dist",
},
{
type: "link",
path: "/troubleshooting/workflow-errors",
title: "Workflow Errors",
},
{
type: "link",
path: "/troubleshooting/test-errors",
title: "Test Errors",
},
],
},
{
type: "link",
path: "/troubleshooting/dist-imports",
title: "Importing from /dist",
type: "category",
title: "Admin Development",
children: [
{
type: "link",
path: "/troubleshooting/medusa-admin/no-widget-route",
title: "Widget or Route not Showing",
},
],
},
{
type: "link",
path: "/troubleshooting/workflow-errors",
title: "Workflow Errors",
type: "category",
title: "Upgrade",
children: [
{
type: "link",
path: "/troubleshooting/errors-after-upgrading",
title: "Errors After Upgrading",
},
],
},
{
type: "link",
path: "/troubleshooting/test-errors",
title: "Test Errors",
type: "category",
title: "Frontend",
children: [
{
type: "link",
path: "/troubleshooting/cors-errors",
title: "CORS Errors",
},
],
},
],
},
{
type: "category",
title: "Admin Development",
children: [
{
type: "link",
path: "/troubleshooting/medusa-admin/no-widget-route",
title: "Widget or Route not Showing",
},
],
},
{
type: "category",
title: "Upgrade",
children: [
{
type: "link",
path: "/troubleshooting/errors-after-upgrading",
title: "Errors After Upgrading",
},
],
},
{
type: "category",
title: "Frontend",
children: [
{
type: "link",
path: "/troubleshooting/cors-errors",
title: "CORS Errors",
},
],
},
{
type: "category",
title: "Integrations",
hasTitleStyling: true,
children: [
{
type: "link",
path: "/troubleshooting/s3",
title: "S3 Module Provider Errors",
type: "category",
title: "Integrations",
hasTitleStyling: true,
children: [
{
type: "link",
path: "/troubleshooting/s3",
title: "S3 Module Provider Errors",
},
],
},
],
},
www/apps/resources/sidebars/user.mjs
+31 -9
View File
@@ -1,9 +1,9 @@
/** @type {import('types').RawSidebarItem[]} */
/** @type {import('types').Sidebar.SidebarItem[]} */
export const userSidebar = [
{
type: "category",
type: "sidebar",
sidebar_id: "user",
title: "User Module",
isChildSidebar: true,
children: [
{
type: "link",
@@ -24,6 +24,7 @@ export const userSidebar = [
autogenerate_tags: "server+user",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to use the User Module in your customizations on the Medusa application server.",
children: [
@@ -40,6 +41,7 @@ export const userSidebar = [
autogenerate_tags: "storefront+user,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to integrate the User Module's features into your storefront.",
},
@@ -49,6 +51,7 @@ export const userSidebar = [
autogenerate_tags: "admin+user,-jsSdk",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize administative features of the User Module.",
},
@@ -58,6 +61,7 @@ export const userSidebar = [
autogenerate_tags: "userGuide+user",
initialOpen: false,
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
description:
"Learn how to utilize and manage User features in the Medusa Admin dashboard.",
},
@@ -79,12 +83,14 @@ export const userSidebar = [
title: "Workflows",
autogenerate_tags: "workflow+user",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "category",
title: "Steps",
autogenerate_tags: "step+user",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -101,6 +107,7 @@ export const userSidebar = [
description:
"The following methods or properties are used to send requests to Store API Routes related to the User Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
{
type: "sub-category",
@@ -109,6 +116,7 @@ export const userSidebar = [
description:
"The following methods or properties are used to send requests to Admin API Routes related to the User Module.",
autogenerate_as_ref: true,
sort_sidebar: "alphabetize",
},
],
},
@@ -123,12 +131,19 @@ export const userSidebar = [
title: "Admin Widget Zones",
},
{
type: "link",
path: "/references/user",
type: "sidebar",
sidebar_id: "user-service-reference",
title: "Main Service Reference",
isChildSidebar: true,
childSidebarTitle: "User Module's Main Service Reference",
children: [
{
type: "link",
path: "/references/user",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Methods",
@@ -138,12 +153,19 @@ export const userSidebar = [
],
},
{
type: "link",
path: "/references/user/models",
type: "sidebar",
sidebar_id: "user-models-reference",
title: "Data Models Reference",
isChildSidebar: true,
childSidebarTitle: "User Module Data Models Reference",
children: [
{
type: "link",
path: "/references/user/models",
title: "Reference Overview",
},
{
type: "separator",
},
{
type: "category",
title: "Data Models",
www/apps/resources/types/index.d.ts
Vendored
-6
View File
@@ -1,6 +0,0 @@
import { SidebarItemType as UiSidebarItemType } from "docs-ui"
export declare type SidebarItemType = UiSidebarItemType & {
autogenerate_path?: string
children?: SidebarItemType[]
}
www/apps/resources/utils/sidebar-attach-common-options.mjs
-24
View File
@@ -1,24 +0,0 @@
/** @type {Partial<import("../types").RawSidebarItem>} */
const commonOptions = {
loaded: true,
isPathHref: true,
}
/**
*
* @param {import("types").RawSidebarItem[]} sidebar
* @returns {import("types").RawSidebarItem[]}
*/
export function sidebarAttachHrefCommonOptions(sidebar) {
return sidebar.map((item) => {
if (item.type === "separator") {
return item
}
return {
...commonOptions,
...item,
children: sidebarAttachHrefCommonOptions(item.children || []),
}
})
}