medusa-store/www/apps/resources/sidebars/product.mjs

/** @type {import('types').RawSidebarItem[]} */
export const productSidebar = [
  {
    type: "category",
    title: "Product Module",
    isChildSidebar: true,
    children: [
      {
        type: "link",
        path: "/commerce-modules/product",
        title: "Overview",
      },
      {
        type: "separator",
      },
      {
        type: "category",
        title: "Concepts",
        initialOpen: false,
        autogenerate_tags: "concept+product",
        autogenerate_as_ref: true,
        children: [
          {
            type: "link",
            path: "/commerce-modules/product/variant-inventory",
            title: "Variant Inventory",
          },
          {
            type: "link",
            path: "/commerce-modules/product/selling-products",
            title: "Selling Use Cases",
          },
          {
            type: "link",
            path: "/commerce-modules/product/links-to-other-modules",
            title: "Links to Other Modules",
          },
        ],
      },
      {
        type: "category",
        title: "Server Guides",
        autogenerate_tags: "server+product",
        initialOpen: false,
        autogenerate_as_ref: true,
        description:
          "Learn how to use the Product Module in your customizations on the Medusa application server.",
        children: [
          {
            type: "link",
            path: "/commerce-modules/product/extend",
            title: "Extend Module",
          },
          {
            type: "link",
            path: "/commerce-modules/product/guides/price",
            title: "Get Variant Prices",
          },
          {
            type: "link",
            path: "/commerce-modules/product/guides/price-with-taxes",
            title: "Get Variant Price with Taxes",
          },
        ],
      },
      {
        type: "category",
        title: "Storefront Guides",
        autogenerate_tags: "storefront+product,-jsSdk",
        initialOpen: false,
        autogenerate_as_ref: true,
        description:
          "Learn how to integrate the Product Module's features into your storefront.",
      },
      {
        type: "category",
        title: "Admin Guides",
        autogenerate_tags: "admin+product,-jsSdk",
        initialOpen: false,
        autogenerate_as_ref: true,
        description:
          "Learn how to utilize administative features of the Product Module.",
      },
      {
        type: "category",
        title: "Admin User Guides",
        autogenerate_tags: "userGuide+product",
        initialOpen: false,
        autogenerate_as_ref: true,
        description:
          "Learn how to utilize and manage Product features in the Medusa Admin dashboard.",
      },
      {
        type: "category",
        title: "References",
        initialOpen: false,
        description:
          "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.",
        children: [
          {
            type: "link",
            path: "/commerce-modules/product/workflows",
            title: "Workflows",
            hideChildren: true,
            children: [
              {
                type: "category",
                title: "Workflows",
                autogenerate_tags: "workflow+product",
                autogenerate_as_ref: true,
              },
              {
                type: "category",
                title: "Steps",
                autogenerate_tags: "step+product",
                autogenerate_as_ref: true,
              },
            ],
          },
          {
            type: "link",
            path: "/commerce-modules/product/js-sdk",
            title: "JS SDK",
            hideChildren: true,
            children: [
              {
                type: "sub-category",
                title: "Store",
                autogenerate_tags: "jsSdk+storefront+product",
                description:
                  "The following methods or properties are used to send requests to Store API Routes related to the Product Module.",
                autogenerate_as_ref: true,
              },
              {
                type: "sub-category",
                title: "Admin",
                autogenerate_tags: "jsSdk+admin+product",
                description:
                  "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.",
                autogenerate_as_ref: true,
              },
            ],
          },
          {
            type: "link",
            path: "/commerce-modules/product/events",
            title: "Events Reference",
          },
          {
            type: "link",
            path: "/commerce-modules/product/admin-widget-zones",
            title: "Admin Widget Zones",
          },
          {
            type: "link",
            path: "/references/product",
            title: "Main Service Reference",
            isChildSidebar: true,
            childSidebarTitle: "Product Module's Main Service Reference",
            children: [
              {
                type: "category",
                title: "Methods",
                autogenerate_path:
                  "/references/product/IProductModuleService/methods",
              },
            ],
          },
          {
            type: "link",
            path: "/references/product/models",
            title: "Data Models Reference",
            isChildSidebar: true,
            childSidebarTitle: "Product Module Data Models Reference",
            children: [
              {
                type: "category",
                title: "Data Models",
                hasTitleStyling: true,
                autogenerate_path: "/references/product_models/variables",
              },
            ],
          },
        ],
      },
    ],
  },
]