From 80d603a63d6ed279c7ceb32061c9cacc2a60e257 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 21 Aug 2023 13:09:59 +0300 Subject: [PATCH] docs: improved glossary definitions (#4820) * docs: improved glossary definitions * Update glossary.ts --- www/docs/src/utils/glossary.ts | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/www/docs/src/utils/glossary.ts b/www/docs/src/utils/glossary.ts index c80b300b29..5d7458a07c 100644 --- a/www/docs/src/utils/glossary.ts +++ b/www/docs/src/utils/glossary.ts @@ -28,7 +28,8 @@ const glossary: GlossaryType[] = [ }, { title: "Dependency Injection", - content: "The act of delivering the required resources to a class", + content: + "Classes receive other resources, such as services or repositories, in their constructor using dependency injection.", matchTextRegex: /(dependency injection|dependency-injection)/i, referenceLink: "/development/fundamentals/dependency-injection", }, @@ -41,7 +42,7 @@ const glossary: GlossaryType[] = [ }, { title: "Endpoint", - content: "REST API exposed to frontends or external systems.", + content: "REST API routes exposed to frontends or external systems.", matchTextRegex: /endpoint/i, referenceLink: "/development/endpoints/overview", }, @@ -54,7 +55,7 @@ const glossary: GlossaryType[] = [ { title: "Module", content: - "Reusable pieces of code that provide specific functionality or feature.", + "Reusable pieces of code, typically as NPM packages, that provide specific functionality or feature.", matchTextRegex: /module/, ignoreTextRegex: /commerce module/i, referenceLink: "/development/modules/overview", @@ -81,13 +82,14 @@ const glossary: GlossaryType[] = [ { title: "Strategy", content: - "A class that contains an isolated piece of logic that can be overridden and customized", + "A class that contains an isolated piece of logic that can be overridden and customized.", matchTextRegex: /(strategy|strategies)/i, referenceLink: "/development/strategies/overview", }, { title: "Feature Flag", - content: "Guards beta features in the Medusa backend.", + content: + "A flag that guards beta features in the Medusa backend and ensures they can only be used when enabled.", matchTextRegex: /(feature-flag|feature flag)/i, referenceLink: "/development/feature-flags/overview", }, @@ -130,7 +132,8 @@ const glossary: GlossaryType[] = [ }, { title: "Service", - content: "A class that includes helper methods associated with an entity.", + content: + "A class that typically includes helper methods associated with an entity.", matchTextRegex: /service/i, ignoreTextRegex: /(file-service|file service|notification service|notification-service|search service|search-service)/i, @@ -160,7 +163,7 @@ const glossary: GlossaryType[] = [ { title: "Admin Widget", content: - "Custom React components that can be injected into different locations in the Medusa admin dashboard", + "Custom React components that can be injected into different locations in the Medusa admin dashboard.", matchTextRegex: /admin widget/i, referenceLink: "/admin/widgets", }, @@ -174,7 +177,7 @@ const glossary: GlossaryType[] = [ { title: "Admin Setting Page", content: - "A React component that is used to create a new setting page in the Medusa admin dashboard", + "A React component that is used to create a new setting page in the Medusa admin dashboard.", matchTextRegex: /admin setting page/i, referenceLink: "/admin/setting-pages", },