docs: revise main docs outline (#10502)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
c8cb9b5c1a
commit
0ae98c51eb
141 files changed
+814
-1181
No files matched your search
+173
-233
@@ -16,80 +16,14 @@ export const sidebar = numberSidebarItems(
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/first-customizations",
|
||||
title: "Your First Customizations",
|
||||
chapterTitle: "First Customization",
|
||||
title: "Architecture",
|
||||
path: "/learn/introduction/architecture",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics",
|
||||
title: "The Basics",
|
||||
chapterTitle: "Basics",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/project-directories-files",
|
||||
title: "Project Conventions",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/medusa-container",
|
||||
title: "Medusa Container",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/modules",
|
||||
title: "Modules",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/api-routes",
|
||||
title: "API Routes",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/commerce-modules",
|
||||
title: "Commerce Modules",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/modules-directory-structure",
|
||||
title: "Modules Directory Structure",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/loaders",
|
||||
title: "Loaders",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/events-and-subscribers",
|
||||
title: "Events and Subscribers",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/scheduled-jobs",
|
||||
title: "Scheduled Jobs",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/workflows",
|
||||
title: "Workflows",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/basics/admin-customizations",
|
||||
title: "Admin Customizations",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/customization",
|
||||
title: "Custom Development",
|
||||
chapterTitle: "Customization",
|
||||
type: "category",
|
||||
title: "Customize",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
@@ -182,348 +116,361 @@ export const sidebar = numberSidebarItems(
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development",
|
||||
title: "Advanced Development",
|
||||
chapterTitle: "Advanced",
|
||||
type: "category",
|
||||
title: "Fundamentals",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
title: "Architecture",
|
||||
path: "/learn/advanced-development/architecture/overview",
|
||||
path: "/learn/fundamentals/medusa-container",
|
||||
title: "Medusa Container",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules",
|
||||
title: "Modules",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/architecture/architectural-modules",
|
||||
path: "/learn/fundamentals/modules/modules-directory-structure",
|
||||
title: "Modules Directory Structure",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/loaders",
|
||||
title: "Loaders",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/isolation",
|
||||
title: "Module Isolation",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/container",
|
||||
title: "Module Container",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/options",
|
||||
title: "Module Options",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/service-factory",
|
||||
title: "Service Factory",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/service-constraints",
|
||||
title: "Service Constraints",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/db-operations",
|
||||
title: "Database Operations",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/multiple-services",
|
||||
title: "Multiple Services",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/commerce-modules",
|
||||
title: "Commerce Modules",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/modules/architectural-modules",
|
||||
title: "Architectural Modules",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
title: "API Routes",
|
||||
path: "/learn/advanced-development/api-routes",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/http-methods",
|
||||
title: "HTTP Methods",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/parameters",
|
||||
title: "Parameters",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/responses",
|
||||
title: "Response",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/middlewares",
|
||||
title: "Middlewares",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/validation",
|
||||
title: "Validation",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/protected-routes",
|
||||
title: "Protected Routes",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/errors",
|
||||
title: "Errors",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/cors",
|
||||
title: "Handling CORS",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/api-routes/additional-data",
|
||||
title: "Additional Data",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules",
|
||||
title: "Modules",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules/isolation",
|
||||
title: "Module Isolation",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules/container",
|
||||
title: "Module Container",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules/options",
|
||||
title: "Module Options",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules/service-factory",
|
||||
title: "Service Factory",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules/service-constraints",
|
||||
title: "Service Constraints",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules/db-operations",
|
||||
title: "Database Operations",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/modules/multiple-services",
|
||||
title: "Multiple Services",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/module-links",
|
||||
path: "/learn/fundamentals/module-links",
|
||||
title: "Module Links",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/module-links/directions",
|
||||
path: "/learn/fundamentals/module-links/directions",
|
||||
title: "Module Link Direction",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/module-links/remote-link",
|
||||
path: "/learn/fundamentals/module-links/remote-link",
|
||||
title: "Remote Link",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/module-links/query",
|
||||
path: "/learn/fundamentals/module-links/query",
|
||||
title: "Query",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/module-links/custom-columns",
|
||||
path: "/learn/fundamentals/module-links/custom-columns",
|
||||
title: "Custom Columns",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models",
|
||||
path: "/learn/fundamentals/data-models",
|
||||
title: "Data Models",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/infer-type",
|
||||
path: "/learn/fundamentals/data-models/infer-type",
|
||||
title: "Infer Type",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/property-types",
|
||||
path: "/learn/fundamentals/data-models/property-types",
|
||||
title: "Property Types",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/primary-key",
|
||||
path: "/learn/fundamentals/data-models/primary-key",
|
||||
title: "Primary Key",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/default-properties",
|
||||
path: "/learn/fundamentals/data-models/default-properties",
|
||||
title: "Default Properties",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/configure-properties",
|
||||
path: "/learn/fundamentals/data-models/configure-properties",
|
||||
title: "Configure Properties",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/relationships",
|
||||
path: "/learn/fundamentals/data-models/relationships",
|
||||
title: "Relationships",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/manage-relationships",
|
||||
path: "/learn/fundamentals/data-models/manage-relationships",
|
||||
title: "Manage Relationships",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/index",
|
||||
path: "/learn/fundamentals/data-models/index",
|
||||
title: "Define Index",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/check-constraints",
|
||||
path: "/learn/fundamentals/data-models/check-constraints",
|
||||
title: "Check Constraints",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/searchable-property",
|
||||
path: "/learn/fundamentals/data-models/searchable-property",
|
||||
title: "Searchable Property",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/data-models/write-migration",
|
||||
path: "/learn/fundamentals/data-models/write-migration",
|
||||
title: "Write Migration",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "sub-category",
|
||||
title: "Events and Subscribers",
|
||||
type: "link",
|
||||
title: "API Routes",
|
||||
path: "/learn/fundamentals/api-routes",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/events-and-subscribers/data-payload",
|
||||
title: "Events Data Payload",
|
||||
path: "/learn/fundamentals/api-routes/http-methods",
|
||||
title: "HTTP Methods",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/events-and-subscribers/emit-event",
|
||||
title: "Emit Event",
|
||||
path: "/learn/fundamentals/api-routes/parameters",
|
||||
title: "Parameters",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "sub-category",
|
||||
title: "Scheduled Jobs",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/scheduled-jobs/execution-number",
|
||||
title: "Execution Number",
|
||||
path: "/learn/fundamentals/api-routes/responses",
|
||||
title: "Response",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/api-routes/middlewares",
|
||||
title: "Middlewares",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/api-routes/validation",
|
||||
title: "Validation",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/api-routes/protected-routes",
|
||||
title: "Protected Routes",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/api-routes/errors",
|
||||
title: "Errors",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/api-routes/cors",
|
||||
title: "Handling CORS",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/api-routes/additional-data",
|
||||
title: "Additional Data",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows",
|
||||
path: "/learn/fundamentals/workflows",
|
||||
title: "Workflows",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/variable-manipulation",
|
||||
path: "/learn/fundamentals/workflows/variable-manipulation",
|
||||
title: "Transform Variables",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/conditions",
|
||||
path: "/learn/fundamentals/workflows/conditions",
|
||||
title: "When-Then Conditions",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/constructor-constraints",
|
||||
path: "/learn/fundamentals/workflows/constructor-constraints",
|
||||
title: "Constructor Constraints",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/compensation-function",
|
||||
path: "/learn/fundamentals/workflows/compensation-function",
|
||||
title: "Compensation Function",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/workflow-hooks",
|
||||
path: "/learn/fundamentals/workflows/workflow-hooks",
|
||||
title: "Workflow Hooks",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/add-workflow-hook",
|
||||
path: "/learn/fundamentals/workflows/add-workflow-hook",
|
||||
title: "Expose a Hook",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/access-workflow-errors",
|
||||
path: "/learn/fundamentals/workflows/access-workflow-errors",
|
||||
title: "Access Workflow Errors",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/retry-failed-steps",
|
||||
path: "/learn/fundamentals/workflows/retry-failed-steps",
|
||||
title: "Retry Failed Steps",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/parallel-steps",
|
||||
path: "/learn/fundamentals/workflows/parallel-steps",
|
||||
title: "Run Steps in Parallel",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/workflow-timeout",
|
||||
path: "/learn/fundamentals/workflows/workflow-timeout",
|
||||
title: "Workflow Timeout",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/long-running-workflow",
|
||||
path: "/learn/fundamentals/workflows/long-running-workflow",
|
||||
title: "Long-Running Workflow",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/execute-another-workflow",
|
||||
path: "/learn/fundamentals/workflows/execute-another-workflow",
|
||||
title: "Execute Another Workflow",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/workflows/multiple-step-usage",
|
||||
path: "/learn/fundamentals/workflows/multiple-step-usage",
|
||||
title: "Multiple Step Usage",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/custom-cli-scripts",
|
||||
title: "Custom CLI Scripts",
|
||||
path: "/learn/fundamentals/events-and-subscribers",
|
||||
title: "Events and Subscribers",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/custom-cli-scripts/seed-data",
|
||||
title: "Seed Data",
|
||||
path: "/learn/fundamentals/events-and-subscribers/data-payload",
|
||||
title: "Events Data Payload",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/events-and-subscribers/emit-event",
|
||||
title: "Emit Event",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/admin",
|
||||
path: "/learn/fundamentals/scheduled-jobs",
|
||||
title: "Scheduled Jobs",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/scheduled-jobs/execution-number",
|
||||
title: "Execution Number",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/admin",
|
||||
title: "Admin Development",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/admin/widgets",
|
||||
path: "/learn/fundamentals/admin/widgets",
|
||||
title: "Admin Widgets",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/admin/ui-routes",
|
||||
path: "/learn/fundamentals/admin/ui-routes",
|
||||
title: "Admin UI Routes",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/admin/constraints",
|
||||
path: "/learn/fundamentals/admin/constraints",
|
||||
title: "Constraints",
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/advanced-development/admin/tips",
|
||||
path: "/learn/fundamentals/admin/tips",
|
||||
title: "Tips",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/custom-cli-scripts",
|
||||
title: "Custom CLI Scripts",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/fundamentals/custom-cli-scripts/seed-data",
|
||||
title: "Seed Data",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "link",
|
||||
title: "Environment Variables",
|
||||
path: "/learn/advanced-development/environment-variables",
|
||||
path: "/learn/fundamentals/environment-variables",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -614,13 +561,6 @@ export const sidebar = numberSidebarItems(
|
||||
type: "link",
|
||||
path: "/learn/more-resources",
|
||||
title: "More Resources",
|
||||
children: [
|
||||
{
|
||||
type: "link",
|
||||
path: "/learn/more-resources/cheatsheet",
|
||||
title: "Cheat Sheet",
|
||||
},
|
||||
],
|
||||
},
|
||||
])
|
||||
)
|
||||
Reference in new issue
Block a user