docs: added documentation pages for experimental features (#5671)
* docs: added documentation pages for experimental features * fix content lint issues * fixed lint errors * added migration step * added workflows introduction * add installation guides * added installation guides for modules + generated workflows reference * added missing workflows reference link * Added warning message for experimental features * fix note
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"$schema": "http://json.schemastore.org/tsconfig",
|
||||
"extends": [
|
||||
"../../../../packages/workflows/tsconfig.json"
|
||||
"../../../../packages/workflows-sdk/tsconfig.json"
|
||||
]
|
||||
}
|
||||
@@ -7,12 +7,12 @@ const pathPrefix = path.join(__dirname, "..", "..", "..")
|
||||
module.exports = {
|
||||
...globalTypedocOptions,
|
||||
entryPoints: [
|
||||
path.join(pathPrefix, "packages/workflows/src/utils/composer/index.ts"),
|
||||
path.join(pathPrefix, "packages/workflows-sdk/src/utils/composer/index.ts"),
|
||||
],
|
||||
out: [path.join(pathPrefix, "www/apps/docs/content/references/workflows")],
|
||||
tsconfig: path.join(__dirname, "extended-tsconfig", "workflows.json"),
|
||||
name: "Workflows Reference",
|
||||
indexTitle: "Workflows Reference",
|
||||
name: "Workflows API Reference",
|
||||
indexTitle: "Workflows API Reference",
|
||||
entryDocument: "index.mdx",
|
||||
hideInPageTOC: true,
|
||||
hideBreadcrumbs: true,
|
||||
@@ -43,6 +43,8 @@ module.exports = {
|
||||
},
|
||||
},
|
||||
"index\\.mdx": {
|
||||
reflectionDescription:
|
||||
"This section of the documentation provides a reference to the utility functions of the `@medusajs/workflows-sdk` package.",
|
||||
reflectionGroups: {
|
||||
Namespaces: false,
|
||||
Enumerations: false,
|
||||
@@ -55,6 +57,18 @@ module.exports = {
|
||||
},
|
||||
functions: {
|
||||
maxLevel: 1,
|
||||
reflectionDescription:
|
||||
"This documentation provides a reference to the `{{alias}}` {{kind}}. It belongs to the `@medusajs/workflows-sdk` package.",
|
||||
frontmatterData: {
|
||||
displayed_sidebar: "workflowsSidebar",
|
||||
slug: "/references/workflows/{{alias}}",
|
||||
sidebar_label: "{{alias}}",
|
||||
},
|
||||
reflectionTitle: {
|
||||
kind: false,
|
||||
typeParameters: false,
|
||||
suffix: "- Workflows Reference",
|
||||
},
|
||||
},
|
||||
"classes/StepResponse": {
|
||||
reflectionGroups: {
|
||||
|
||||
Reference in New Issue
Block a user