asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: added documentation pages for experimental features (#5671)

Browse Source 
* 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:
Shahed Nasser
2023-11-27 16:49:12 +00:00
committed by GitHub
parent cf0939aab2
commit cdc1da5df7
148 changed files with 14225 additions and 435 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
www/apps/docs/sidebars.js
View File

@@ -639,18 +639,6 @@ module.exports = {
id: "modules/products/categories",
label: "Categories",
},
{
type: "html",
value: "References",
customProps: {
sidebar_is_group_divider: true,
},
},
{
type: "ref",
id: "references/product/interfaces/IProductModuleService",
label: "Product Module Interface Reference",
},
{
type: "html",
value: "How-to",
@@ -673,11 +661,6 @@ module.exports = {
id: "modules/products/admin/import-products",
label: "Admin: Import Products",
},
{
type: "doc",
id: "modules/products/serverless-module",
label: "Storefront: Serverless Module",
},
{
type: "doc",
id: "modules/products/storefront/show-products",
@@ -1161,18 +1144,6 @@ module.exports = {
id: "modules/price-lists/price-selection-strategy",
label: "Price Selection Strategy",
},
{
type: "html",
value: "References",
customProps: {
sidebar_is_group_divider: true,
},
},
{
type: "ref",
id: "references/pricing/interfaces/IPricingModuleService",
label: "Pricing Module Interface Reference",
},
{
type: "html",
value: "How-to",
@@ -1378,6 +1349,29 @@ module.exports = {
},
collapsible: false,
items: [
{
type: "category",
label: "Workflows",
items: [
{
type: "doc",
id: "development/workflows/index",
label: "Introduction",
},
{
type: "html",
value: "References",
customProps: {
sidebar_is_group_divider: true,
},
},
{
type: "ref",
id: "references/workflows/index",
label: "API Reference",
},
],
},
{
type: "category",
label: "Entity",
@@ -1969,6 +1963,14 @@ module.exports = {
},
],
},
{
type: "ref",
label: "Experimental Features",
id: "experimental/index",
customProps: {
sidebar_is_group_headline: true,
},
},
],
upgradeGuides: [
{
@@ -2646,6 +2648,124 @@ module.exports = {
dirName: "user-guide",
},
],
experimentalSidebar: [
{
type: "ref",
id: "development/overview",
label: "Back to Medusa Development",
customProps: {
sidebar_is_back_link: true,
sidebar_icon: "back-arrow",
},
},
{
type: "doc",
id: "experimental/index",
label: "Experimental",
customProps: {
sidebar_is_title: true,
sidebar_icon: "beaker",
},
},
{
type: "category",
label: "Pricing Module",
customProps: {
sidebar_is_group_headline: true,
},
collapsible: true,
collapsed: false,
items: [
{
type: "doc",
label: "Overview",
id: "experimental/pricing/overview",
},
{
type: "doc",
label: "Install in Medusa",
id: "experimental/pricing/install-medusa",
},
{
type: "doc",
label: "Install in Node.js",
id: "experimental/pricing/install-nodejs",
},
{
type: "doc",
label: "Examples",
id: "experimental/pricing/examples",
},
{
type: "html",
value: "Architecture",
customProps: {
sidebar_is_group_divider: true,
},
},
{
type: "doc",
label: "Pricing Concepts",
id: "experimental/pricing/concepts",
},
{
type: "doc",
label: "Prices Calculation",
id: "experimental/pricing/prices-calculation",
},
{
type: "html",
value: "References",
customProps: {
sidebar_is_group_divider: true,
},
},
{
type: "ref",
id: "references/pricing/interfaces/IPricingModuleService",
label: "Interface Reference",
},
],
},
{
type: "category",
label: "Product Module",
customProps: {
sidebar_is_group_headline: true,
},
collapsible: true,
collapsed: false,
items: [
{
type: "doc",
label: "Overview",
id: "experimental/product/overview",
},
{
type: "doc",
label: "Install in Medusa",
id: "experimental/product/install-medusa",
},
{
type: "doc",
label: "Install in Node.js",
id: "experimental/product/install-nodejs",
},
{
type: "html",
value: "References",
customProps: {
sidebar_is_group_divider: true,
},
},
{
type: "ref",
id: "references/product/interfaces/IProductModuleService",
label: "Interface Reference",
},
],
},
],
servicesSidebar: [
{
type: "ref",
@@ -3192,4 +3312,38 @@ module.exports = {
],
},
],
workflowsSidebar: [
{
type: "ref",
id: "modules/overview",
label: "Back to Commerce Modules",
customProps: {
sidebar_is_back_link: true,
sidebar_icon: "back-arrow",
},
},
{
type: "doc",
id: "references/workflows/index",
label: "Workflows API Reference",
customProps: {
sidebar_is_title: true,
sidebar_icon: "folder-open",
},
},
{
type: "category",
label: "Functions",
collapsible: false,
customProps: {
sidebar_is_group_headline: true,
},
items: [
{
type: "autogenerated",
dirName: "references/workflows/functions",
},
],
},
],
}