docs: generate inventory and stock location references (#5645)

This commit is contained in:
Shahed Nasser
2023-11-16 11:10:23 +02:00
committed by GitHub
parent ecabd38b07
commit 95aa5a2d28
88 changed files with 10191 additions and 1 deletions

View File

@@ -0,0 +1,47 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const modulesConfig = require("./_modules")
module.exports = modulesConfig({
entryPointPath: "packages/types/src/inventory/service.ts",
outPath: "www/apps/docs/content/references/inventory",
moduleName: "Inventory Module Reference",
documentsToFormat: [
{
pattern: "*",
useDefaults: true,
additionalFormatting: {
frontmatterData: {
displayed_sidebar: "inventoryReference",
},
},
},
{
pattern: "IInventoryService/methods",
additionalFormatting: {
reflectionDescription:
"This documentation provides a reference to the `{{alias}}` {{kind}}. This belongs to the Inventory Module.",
frontmatterData: {
displayed_sidebar: "inventoryReference",
slug: "/references/inventory/{{alias}}",
sidebar_label: "{{alias}}",
},
reflectionTitle: {
kind: false,
typeParameters: false,
suffix: "- Inventory Module Reference",
},
},
},
{
pattern: "IInventoryService.md",
additionalFormatting: {
reflectionDescription:
"This section of the documentation provides a reference to the `IInventoryService` interfaces methods. This is the interface developers use to use the functionalities provided by the Inventory Module.",
frontmatterData: {
displayed_sidebar: "inventoryReference",
slug: "/references/inventory",
},
},
},
],
})

View File

@@ -0,0 +1,47 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const modulesConfig = require("./_modules")
module.exports = modulesConfig({
entryPointPath: "packages/types/src/stock-location/service.ts",
outPath: "www/apps/docs/content/references/stock-location",
moduleName: "Stock Location Module Reference",
documentsToFormat: [
{
pattern: "*",
useDefaults: true,
additionalFormatting: {
frontmatterData: {
displayed_sidebar: "stockLocationReference",
},
},
},
{
pattern: "IStockLocationService/methods",
additionalFormatting: {
reflectionDescription:
"This documentation provides a reference to the `{{alias}}` {{kind}}. This belongs to the Stock Location Module.",
frontmatterData: {
displayed_sidebar: "stockLocationReference",
slug: "/references/stock-location/{{alias}}",
sidebar_label: "{{alias}}",
},
reflectionTitle: {
kind: false,
typeParameters: false,
suffix: "- Stock Location Module Reference",
},
},
},
{
pattern: "IStockLocationService.md",
additionalFormatting: {
reflectionDescription:
"This section of the documentation provides a reference to the `IStockLocationService` interfaces methods. This is the interface developers use to use the functionalities provided by the Stock Location Module.",
frontmatterData: {
displayed_sidebar: "stockLocationReference",
slug: "/references/stock-location",
},
},
},
],
})