Skip to content

Commit

Permalink
docs: added documentation pages for experimental features (#5671)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
shahednasser committed Nov 27, 2023
1 parent cf0939a commit cdc1da5
Show file tree
Hide file tree
Showing 148 changed files with 14,225 additions and 435 deletions.
@@ -1,6 +1,6 @@
{
"$schema": "http://json.schemastore.org/tsconfig",
"extends": [
"../../../../packages/workflows/tsconfig.json"
"../../../../packages/workflows-sdk/tsconfig.json"
]
}
20 changes: 17 additions & 3 deletions docs-util/packages/typedoc-config/workflows.js
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand All @@ -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: {
Expand Down

3 comments on commit cdc1da5

@vercel
Copy link

@vercel vercel bot commented on cdc1da5 Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

api-reference – ./www/apps/api-reference

api-reference-delta.vercel.app
api-reference-medusajs.vercel.app
docs.medusajs.com
api-reference-git-develop-medusajs.vercel.app

@vercel
Copy link

@vercel vercel bot commented on cdc1da5 Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs-ui – ./www/apps/ui

docs-ui.vercel.app
docs-ui-medusajs.vercel.app
docs-ui-git-develop-medusajs.vercel.app

@vercel
Copy link

@vercel vercel bot commented on cdc1da5 Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

medusa-docs – ./www/apps/docs

medusa-docs-medusajs.vercel.app
medusa-docs.vercel.app
medusa-docs-git-develop-medusajs.vercel.app

Please sign in to comment.