Skip to content

Commit cdc1da5

Browse files
authored
docs: added documentation pages for experimental features (medusajs#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
1 parent cf0939a commit cdc1da5

File tree

148 files changed

+14225
-435
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+14225
-435
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "http://json.schemastore.org/tsconfig",
33
"extends": [
4-
"../../../../packages/workflows/tsconfig.json"
4+
"../../../../packages/workflows-sdk/tsconfig.json"
55
]
66
}

docs-util/packages/typedoc-config/workflows.js

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ const pathPrefix = path.join(__dirname, "..", "..", "..")
77
module.exports = {
88
...globalTypedocOptions,
99
entryPoints: [
10-
path.join(pathPrefix, "packages/workflows/src/utils/composer/index.ts"),
10+
path.join(pathPrefix, "packages/workflows-sdk/src/utils/composer/index.ts"),
1111
],
1212
out: [path.join(pathPrefix, "www/apps/docs/content/references/workflows")],
1313
tsconfig: path.join(__dirname, "extended-tsconfig", "workflows.json"),
14-
name: "Workflows Reference",
15-
indexTitle: "Workflows Reference",
14+
name: "Workflows API Reference",
15+
indexTitle: "Workflows API Reference",
1616
entryDocument: "index.mdx",
1717
hideInPageTOC: true,
1818
hideBreadcrumbs: true,
@@ -43,6 +43,8 @@ module.exports = {
4343
},
4444
},
4545
"index\\.mdx": {
46+
reflectionDescription:
47+
"This section of the documentation provides a reference to the utility functions of the `@medusajs/workflows-sdk` package.",
4648
reflectionGroups: {
4749
Namespaces: false,
4850
Enumerations: false,
@@ -55,6 +57,18 @@ module.exports = {
5557
},
5658
functions: {
5759
maxLevel: 1,
60+
reflectionDescription:
61+
"This documentation provides a reference to the `{{alias}}` {{kind}}. It belongs to the `@medusajs/workflows-sdk` package.",
62+
frontmatterData: {
63+
displayed_sidebar: "workflowsSidebar",
64+
slug: "/references/workflows/{{alias}}",
65+
sidebar_label: "{{alias}}",
66+
},
67+
reflectionTitle: {
68+
kind: false,
69+
typeParameters: false,
70+
suffix: "- Workflows Reference",
71+
},
5872
},
5973
"classes/StepResponse": {
6074
reflectionGroups: {

0 commit comments

Comments
 (0)