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

docs: improved commerce modules [5/5] (#9592)

Browse Source 
- Improve remaining commerce modules
- Other: add a note about using methods of the modules' main services.
This commit is contained in:
Shahed Nasser
2024-10-16 13:25:21 +03:00
committed by GitHub
parent 6e856d3156
commit eed88c95ec
42 changed files with 594 additions and 582 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
www/utils/packages/typedoc-generate-references/src/constants/merger-options.ts
View File

@@ -88,7 +88,13 @@ const mergerOptions: Partial<TypeDocOptions> = {
},
},
[`^${snakeCaseModuleName}/${moduleServiceName}/methods`]: {
reflectionDescription: `This documentation provides a reference to the \`{{alias}}\` {{kind}}. This belongs to the ${titleModuleName} Module.`,
reflectionDescription: `This documentation provides a reference to the \`{{alias}}\` {{kind}}. This belongs to the ${titleModuleName} Module.
<Note>
You should only use this methods when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>`,
frontmatterData: {
displayed_sidebar: `${camelCaseModuleName}Reference`,
slug: `/references/${moduleName}/{{alias}}`,
@@ -101,7 +107,13 @@ const mergerOptions: Partial<TypeDocOptions> = {
},
},
[`^${snakeCaseModuleName}/.*${moduleServiceName}/page\\.mdx`]: {
reflectionDescription: `This section of the documentation provides a reference to the \`${moduleServiceName}\` interface’s methods. This is the interface developers use to use the functionalities provided by the ${titleModuleName} Module.`,
reflectionDescription: `This section of the documentation provides a reference to the \`${moduleServiceName}\` interface’s methods. This is the interface developers use to use the functionalities provided by the ${titleModuleName} Module.
<Note>
You should only use the methods in this reference when implementing complex customizations. For common cases, check out [available workflows instead](/medusa-workflows-reference).
</Note>`,
frontmatterData: {
displayed_sidebar: `${camelCaseModuleName}Reference`,
slug: `/references/${moduleName}`,