docs: restructured docs sidebar (#2156)

* restructured docs sidebar

* resolved incorrect URLs
This commit is contained in:
Shahed Nasser
2022-09-06 19:16:54 +03:00
committed by GitHub
parent cd217c8a95
commit a71cf60060
30 changed files with 694 additions and 478 deletions
+185 -181
View File
@@ -10,45 +10,50 @@
*/
module.exports = {
tutorialSidebar: [
{
type: "doc",
id: "homepage",
label: "Overview",
},
{
type: "doc",
id: "introduction",
label: "Introduction",
},
{
type: "doc",
id: "quickstart/quick-start",
label: "Quickstart Guide",
},
{
type: "doc",
id: "usage",
},
docsSidebar: [
{
type: "category",
collapsed: false,
label: "Usage Guides",
label: "Getting Started",
items: [
{
type: "doc",
id: "homepage",
label: "Overview",
},
{
type: "doc",
id: "introduction",
label: "Introduction",
},
{
type: "doc",
id: "quickstart/quick-start",
label: "Quickstart Guide",
},
{
type: "doc",
id: "usage",
},
]
},
{
type: "category",
label: "Setup & Deployment",
items: [
{
type: "doc",
id: "tutorial/set-up-your-development-environment",
label: "Set Up your Development Environment"
label: "Set Up Development Environment"
},
{
type: "doc",
id: "usage/configurations",
label: "Configure your Server"
label: "Configure Server"
},
{
type: "category",
collapsed: true,
label: "Storefront Quickstart",
label: "Storefronts",
items: [
{
type: "doc",
@@ -146,177 +151,150 @@ module.exports = {
},
],
},
{
type: "category",
label: 'Upgrade Guides',
collapsed: true,
link: {
type: 'doc',
id: 'advanced/backend/upgrade-guides/index'
},
items: [
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-0",
label: "v1.3.0"
},
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-6",
label: "v1.3.6"
},
]
},
]
},
{
type: "category",
label: "Advanced Guide",
collapsed: false,
label: "How-to Guides",
items: [
{
type: "category",
label: "Medusa Server",
collapsed: true,
items: [
{
type: "category",
label: 'Endpoints',
collapsed: true,
items: [
{
type: "doc",
id: "advanced/backend/endpoints/add-storefront",
label: "Create Endpoint for Storefront"
},
{
type: "doc",
id: "advanced/backend/endpoints/add-admin",
label: "Create Endpoint for Admin"
},
]
},
{
type: "doc",
id: "advanced/backend/services/create-service",
label: "Create a Service"
},
{
type: "category",
label: 'Subscribers',
collapsed: true,
items: [
{
type: "doc",
id: "advanced/backend/subscribers/create-subscriber",
label: "Create a Subscriber"
},
{
type: "doc",
id: "advanced/backend/subscribers/events-list",
label: "List of Events"
},
]
},
{
type: "doc",
id: "advanced/backend/entities",
label: "Entities"
},
{
type: "category",
label: 'Shipping',
collapsed: true,
items: [
{
type: "doc",
id: "advanced/backend/shipping/overview",
label: "Architecture Overview"
},
{
type: "doc",
id: "advanced/backend/shipping/add-fulfillment-provider",
label: "Create a Fulfillment Provider"
}
]
},
{
type: "category",
label: 'Payment',
collapsed: true,
items: [
{
type: "doc",
id: "advanced/backend/payment/overview",
label: "Architecture Overview"
},
{
type: "doc",
id: "advanced/backend/payment/how-to-create-payment-provider",
label: "Create a Payment Provider"
},
]
},
{
type: "category",
label: "Notification",
collapsed: true,
items: [
{
type: "doc",
id: "advanced/backend/notification/overview"
},
{
type: "doc",
id: "advanced/backend/notification/how-to-create-notification-provider",
label: "Create a Notification Provider"
}
]
},
{
type: "category",
label: "Plugins",
collapsed: true,
items: [
{
type: "doc",
id: "advanced/backend/plugins/overview",
label: "Overview"
},
{
type: "doc",
id: "advanced/backend/plugins/create",
}
]
},
{
type: "doc",
id: "advanced/backend/migrations",
label: "Migrations"
},
{
type: "category",
label: 'Upgrade Guides',
collapsed: true,
link: {
type: 'doc',
id: 'advanced/backend/upgrade-guides/index'
},
items: [
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-0",
label: "v1.3.0"
},
{
type: "doc",
id: "advanced/backend/upgrade-guides/1-3-6",
label: "v1.3.6"
},
]
},
]
type: "doc",
id: "advanced/backend/endpoints/add-storefront",
label: "Create Endpoint for Storefront"
},
{
type: "doc",
id: "advanced/backend/endpoints/add-admin",
label: "Create Endpoint for Admin"
},
{
type: "doc",
id: "advanced/backend/services/create-service",
label: "Create a Service"
},
{
type: "doc",
id: "advanced/backend/subscribers/create-subscriber",
label: "Create a Subscriber"
},
{
type: "doc",
id: "advanced/backend/entities/index",
label: "Create an Entity"
},
{
type: "doc",
id: "advanced/backend/shipping/add-fulfillment-provider",
label: "Create a Fulfillment Provider"
},
{
type: "doc",
id: "advanced/backend/payment/how-to-create-payment-provider",
label: "Create a Payment Provider"
},
{
type: "doc",
id: "advanced/backend/notification/how-to-create-notification-provider",
label: "Create a Notification Provider"
},
{
type: "doc",
id: "advanced/backend/plugins/create",
label: "Create a Plugin"
},
{
type: "doc",
id: "advanced/backend/migrations/index",
label: "Create a Migration"
},
{
type: "category",
label: "Storefront",
collapsed: true,
items: [
{
type: "doc",
id: "advanced/storefront/how-to-implement-checkout-flow",
id: "guides/carts-in-medusa",
label: "Implement Cart"
},
{
type: "doc",
id: "guides/carts-in-medusa",
id: "advanced/storefront/how-to-implement-checkout-flow",
label: "Implement Checkout"
},
]
}
]
},
{
type: "category",
label: "Conceptual Guides",
items: [
{
type: "doc",
id: "advanced/backend/services/overview",
label: "Services"
},
{
type: "doc",
id: "advanced/backend/subscribers/overview",
label: "Subscribers"
},
{
type: "doc",
id: "advanced/backend/entities/overview",
label: "Entities"
},
{
type: "doc",
id: "advanced/backend/shipping/overview",
label: "Shipping Architecture"
},
{
type: "doc",
id: "advanced/backend/payment/overview",
label: "Payment Architecture"
},
{
type: "doc",
id: "advanced/backend/notification/overview",
label: "Notification Architecture"
},
{
type: "doc",
id: "advanced/backend/plugins/overview",
label: "Plugins"
},
{
type: "doc",
id: "advanced/backend/migrations/overview",
label: "Migrations"
},
]
},
{
type: "category",
label: "Integrations",
collapsed: false,
items: [
{
type: "category",
@@ -483,14 +461,40 @@ module.exports = {
],
},
{
type: "doc",
id: "cli/reference",
label: "CLI Reference",
},
{
type: "doc",
id: "contribution-guidelines",
label: "Contribution Guidelines",
type: "category",
label: "References",
items: [
{
type: "doc",
id: "cli/reference",
label: "CLI Reference",
},
{
type: "doc",
id: "contribution-guidelines",
label: "Contribution Guidelines",
},
{
type: "ref",
id: "references/entities/classes/Address",
label: "Entities Reference",
},
{
type: "doc",
id: "advanced/backend/subscribers/events-list",
label: "Events Reference"
},
{
type: "ref",
id: "js-client/overview",
label: "JS Client Reference",
},
{
type: "ref",
id: "references/services/classes/AuthService",
label: "Services Reference",
},
]
},
],
userGuideSidebar: [