docs: fixes and preparations for workflows reference (#8579)
- Fix the merger configuration that adds the correct slug / sidebar labels - Add an overview page for the workflows reference. - Fixes to components and build scripts
This commit is contained in:
@@ -11,42 +11,7 @@ const coreFlowsOptions: FormattingOptionsType = {
|
||||
workflowDiagramComponent: "WorkflowDiagram",
|
||||
mdxImports: [`import { TypeList, WorkflowDiagram } from "docs-ui"`],
|
||||
},
|
||||
"^modules/core_flows/page\\.mdx": {
|
||||
reflectionDescription:
|
||||
"This section of the documentation provides a reference to Medusa's workflows and steps that you can use in your customizations.",
|
||||
reflectionGroups: {
|
||||
Namespaces: true,
|
||||
Enumerations: false,
|
||||
Classes: false,
|
||||
Interfaces: false,
|
||||
"Type Aliases": false,
|
||||
Variables: false,
|
||||
"Enumeration Members": false,
|
||||
Functions: false,
|
||||
},
|
||||
hideTocHeaders: true,
|
||||
frontmatterData: {
|
||||
slug: "/references/medusa-workflows",
|
||||
},
|
||||
reflectionTitle: {
|
||||
fullReplacement: "Medusa Workflows API Reference",
|
||||
},
|
||||
},
|
||||
"^core_flows/.*/.*(Workflows|Steps)/page\\.mdx": {
|
||||
expandMembers: false,
|
||||
reflectionGroups: {
|
||||
Variables: false,
|
||||
Properties: false,
|
||||
"Type Literals": false,
|
||||
},
|
||||
sections: {
|
||||
...baseSectionsOptions,
|
||||
member_getterSetter: false,
|
||||
members_categories: false,
|
||||
},
|
||||
hideTocHeaders: true,
|
||||
},
|
||||
"^core_flows/.*Workflows/functions/.*/page\\.mdx": {
|
||||
"^core_flows/.*/functions/.*Workflow/page\\.mdx": {
|
||||
reflectionDescription:
|
||||
"This documentation provides a reference to the `{{alias}}`. It belongs to the `@medusajs/core-flows` package.",
|
||||
frontmatterData: {
|
||||
@@ -59,7 +24,7 @@ const coreFlowsOptions: FormattingOptionsType = {
|
||||
suffix: "- Medusa Workflows API Reference",
|
||||
},
|
||||
},
|
||||
"^core_flows/.*Steps/functions/.*/page\\.mdx": {
|
||||
"^core_flows/.*/functions/.*Step/page\\.mdx": {
|
||||
reflectionDescription:
|
||||
"This documentation provides a reference to the `{{alias}}`. It belongs to the `@medusajs/core-flows` package.",
|
||||
frontmatterData: {
|
||||
|
||||
Reference in New Issue
Block a user