docs: generate medusa-react reference (#6004)

* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-01-05 17:03:38 +02:00
1 parent 6fc6a9de6a
commit 7d650771d1
2811 files changed
+231856 -455063

No files matched your search

+104 -4
View File
@@ -3218,7 +3218,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/IPricingModuleService/methods",
dirName: "references/pricing/IPricingModuleService/methods",
},
],
},
@@ -3252,7 +3252,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/IProductModuleService/methods",
dirName: "references/product/IProductModuleService/methods",
},
],
},
@@ -3286,7 +3286,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/IInventoryService/methods",
dirName: "references/inventory/IInventoryService/methods",
},
],
},
@@ -3320,7 +3320,7 @@ module.exports = {
items: [
{
type: "autogenerated",
dirName: "references/IStockLocationService/methods",
dirName: "references/stock_location/IStockLocationService/methods",
},
],
},
@@ -3359,4 +3359,104 @@ module.exports = {
],
},
],
medusaReactSidebar: [
{
type: "ref",
id: "homepage",
label: "Back to home",
customProps: {
sidebar_is_back_link: true,
sidebar_icon: "back-arrow",
},
},
{
type: "doc",
id: "medusa-react/overview",
label: "Medusa React Reference",
customProps: {
sidebar_is_title: true,
sidebar_icon: "folder-open",
},
},
{
type: "category",
label: "Hooks",
collapsible: false,
customProps: {
sidebar_is_group_headline: true,
},
link: {
type: "doc",
id: "references/medusa_react/medusa_react.Hooks",
},
items: [
{
type: "category",
label: "Admin",
collapsible: true,
link: {
type: "doc",
id: "references/medusa_react/Hooks/medusa_react.Hooks.Admin",
},
items: [
{
type: "autogenerated",
dirName: "references/medusa_react/Hooks/Admin",
},
],
},
{
type: "category",
label: "Store",
collapsible: true,
link: {
type: "doc",
id: "references/medusa_react/Hooks/medusa_react.Hooks.Store",
},
items: [
{
type: "autogenerated",
dirName: "references/medusa_react/Hooks/Store",
},
],
},
],
},
{
type: "category",
label: "Providers",
collapsible: false,
customProps: {
sidebar_is_group_headline: true,
},
link: {
type: "doc",
id: "references/medusa_react/medusa_react.Providers",
},
items: [
{
type: "autogenerated",
dirName: "references/medusa_react/Providers",
},
],
},
{
type: "category",
label: "Utilities",
collapsible: false,
customProps: {
sidebar_is_group_headline: true,
},
link: {
type: "doc",
id: "references/medusa_react/medusa_react.Utilities",
},
items: [
{
type: "autogenerated",
dirName: "references/medusa_react/Utilities/functions",
},
],
},
],
}