docs: update all meta keywords and description

tsedio · Dec 14, 2024 · 9ce84ac · 9ce84ac
1 parent 3e9588f
commit 9ce84ac
Show file tree

Hide file tree

Showing 56 changed files with 388 additions and 149 deletions.
diff --git a/docs/docs/authentication.md b/docs/docs/authentication.md
@@ -2,10 +2,10 @@
 head:
   - - meta
     - name: description
-      content: Authentication configuration
+      content: Discover how to use authentication in Ts.ED to protect your route with your own strategy.
   - - meta
     - name: keywords
-      content: ts.ed express typescript auth node.js javascript decorators
+      content: authentication ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
 ---
 
 # Authentication

diff --git a/docs/docs/controllers.md b/docs/docs/controllers.md
@@ -2,7 +2,7 @@
 head:
   - - meta
     - name: description
-      content: Documentation over Controllers provided by Ts.ED framework. Use controllers to build your REST API.
+      content: Discover how to create controllers and Rest API in Ts.ED to handle incoming requests and return responses to the client.
   - - meta
     - name: keywords
       content: controllers ts.ed express typescript node.js javascript decorators jsonschema class models

diff --git a/docs/docs/custom-providers.md b/docs/docs/custom-providers.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Learn how to create custom providers in Ts.ED to bind something directly to the IoC container.
+  - - meta
+    - name: keywords
+      content: custom providers ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # Custom providers
 
 There are a lot of scenarios where you might want to bind something directly to the IoC container.

diff --git a/docs/docs/hooks.md b/docs/docs/hooks.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Discover how to use hooks in Ts.ED to subscribe to lifecycle events and perform actions when they occur.
+  - - meta
+    - name: keywords
+      content: hooks ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # Hooks
 
 ## Introduction

diff --git a/docs/docs/injection-scopes.md b/docs/docs/injection-scopes.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Discover how to use injection scopes in Ts.ED to define the lifecycle and visibility of a provider.
+  - - meta
+    - name: keywords
+      content: injection scopes ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # Injection scopes
 
 The scope of a [Provider](/docs/providers.md) defines the lifecycle and visibility of that bean in the context in which it is used.

diff --git a/docs/docs/interceptors.md b/docs/docs/interceptors.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Discover how to use interceptors in Ts.ED to bind extra logic before/after method execution, transform the result returned from a function, transform the exception thrown from a function, extend the basic function's behavior, or completely override a function depending on specific conditions.
+  - - meta
+    - name: keywords
+      content: interceptors ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # Interceptors
 
 An interceptor is a class annotated with the @@Interceptor@@ decorator. Interceptors should implement the @@InterceptorMethods@@ interface.

diff --git a/docs/docs/json-mapper.md b/docs/docs/json-mapper.md
@@ -2,7 +2,7 @@
 head:
   - - meta
     - name: description
-      content: Documentation over JsonMapper and decorators provided by Ts.ED framework. Use decorator to build your model and map data.
+      content: Discover how to use the @tsed/json-mapper package to map a plain object to a model and a model to a plain object. Learn how to configure the package and use decorators to describe a model and transform object depending on which operation you want to perform.
   - - meta
     - name: keywords
       content: class model decorators ts.ed express typescript node.js javascript jsonschema json mapper serialization deserialization

diff --git a/docs/docs/model.md b/docs/docs/model.md
@@ -2,10 +2,10 @@
 head:
   - - meta
     - name: description
-      content: Documentation over Models and decorators provided by Ts.ED framework. Use decorator to build your model and JsonSchema.
+      content: Discover how to create a model with Ts.ED. The classes can be used as a model in your application. Ts.ED uses these models to convert JSON objects to their class equivalents.
   - - meta
     - name: keywords
-      content: class model decorators ts.ed express typescript node.js javascript jsonschema
+      content: class model decorators ts.ed express typescript node.js javascript jsonschema validation ajv swagger
 ---
 
 # Model

diff --git a/docs/docs/not-found-page.md b/docs/docs/not-found-page.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Customize the 404 response error when a resource or route isn't resolved by the router in Ts.ED.
+  - - meta
+    - name: keywords
+      content: 404 not found error customize response ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # Customize 404
 
 The guide shows you how you can customize the 404 response error when a resource or route isn't resolved by

diff --git a/docs/docs/paltform-api.md b/docs/docs/paltform-api.md
diff --git a/docs/docs/pipes.md b/docs/docs/pipes.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Discover Pipes in Ts.ED. Pipes are classes annotated with the Injectable decorator and must be used to transform parameters values before they are received by the route handler method.
+  - - meta
+    - name: keywords
+      content: pipes ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # Pipes
 
 A pipe is a class annotated with the @@Injectable@@ decorator.

diff --git a/docs/docs/platform-api.md b/docs/docs/platform-api.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Ts.ED uses the Platform API to create an application. Platform API gives an abstraction layer between your code written with Ts.ED and the Express.js code. It means that a large part of your code isn't coupled with Express.js itself and can be used with another Platform like Koa.js.
+  - - meta
+    - name: keywords
+      content: platform api express koa serverless ts.ed framework typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # Platform API
 
 Ts.ED uses now the Platform API to create an application. Platform API gives an abstraction layer between your code written with Ts.ED and the [Express.js](https://expressjs.com/fr/) code.

diff --git a/docs/docs/providers.md b/docs/docs/providers.md
@@ -2,10 +2,10 @@
 head:
   - - meta
     - name: description
-      content: Documentation over Providers / DI provided by Ts.ED framework. Use providers to build your backend services.
+      content: Discover Ts.ED Providers / DI. Learn how to create a provider, inject dependencies, and use the functional API to define your providers.
   - - meta
     - name: keywords
-      content: providers di ioc ts.ed express typescript node.js javascript decorators jsonschema class models
+      content: providers di ioc ts.ed express typescript node.js javascript decorators jsonschema class models pipes middlewares testing
 ---
 
 # DI & Providers

diff --git a/docs/docs/request-context.md b/docs/docs/request-context.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Ts.ED provides an utility to get request, response, to store and share data along all middlewares/endpoints during a request with PlatformContext. This context is created by Ts.ED when the request is handled by the server.
+  - - meta
+    - name: keywords
+      content: ts.ed express koa typescript request response context platform-context platform-request platform-response
+---
+
 # Context
 
 Ts.ED provides an utility to get request, response, to store and share data along all middlewares/endpoints during a

diff --git a/docs/docs/response-filter.md b/docs/docs/response-filter.md
@@ -2,7 +2,7 @@
 head:
   - - meta
     - name: description
-      content: Documentation over response filters provided by Ts.ED framework. Use class to transform data before returning it to your consumer.
+      content: Discover response filters provided by Ts.ED framework. Use class to transform data before returning it to your consumer.
   - - meta
     - name: keywords
       content: response filter ts.ed express typescript node.js javascript decorators jsonschema class models

diff --git a/docs/docs/services.md b/docs/docs/services.md
diff --git a/docs/docs/session.md b/docs/docs/session.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Ts.ED provides two decorators to get Session and Cookies values in your controller. Learn how to use them in your Ts.ED application.
+  - - meta
+    - name: keywords
+      content: ts.ed express typescript session cookies node.js javascript decorators
+---
+
 # Session & cookies
 
 Ts.ED provides two decorators to get @@Session@@ and @@Cookies@@ values in your controller.

diff --git a/docs/docs/testing.md b/docs/docs/testing.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Learn how to test your Ts.ED application with Jest and Vitest.
+  - - meta
+    - name: keywords
+      content: testing ts.ed jest vitest unit integration e2e rest api request context
+---
+
 # Testing
 
 ## Unit test

diff --git a/docs/docs/validation.md b/docs/docs/validation.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Use Ts.ED validation system to validate your data. Ts.ED provides a set of decorators to validate your data.
+  - - meta
+    - name: keywords
+      content: validation ajv ts.ed express typescript node.js javascript decorators jsonschema class models
+---
+
 # Validation
 
 <Banner src="/ajv_logo.png" href="https://ajv.js.org/" height="100" />

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,4 +1,12 @@
 ---
+head:
+  - - meta
+    - name: description
+      content: Start your first Ts.ED project with the CLI or clone a starter project. Ts.ED provides a conventional base structure for your project, making it easy to get started. Choose from a variety of starter projects to find the one that best suits your needs.
+  - - meta
+    - name: keywords
+      content: installation ts.ed framework express koa aws cli di rest graphql typescript node.js bun.js javascript native ESM decorators jsonschema class models providers pipes middlewares testing developer
+
 projects:
   - title: Kit basic
     href: https://github.com/tsedio/tsed-getting-started

diff --git a/docs/introduction/capabilities.md b/docs/introduction/capabilities.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Discover the capabilities of Ts.ED, a Node.js and TypeScript framework on top of Express/Koa.js. Ts.ED provides different platform adapters to build your awesome server-side application. Depending on the platform you choose, Ts.ED provides a level of abstraction above these common Node.js frameworks (Express/Koa) with the Platform API but some features are not available on all platforms.
+  - - meta
+    - name: keywords
+      content: capabilities platform express koa serverless cli controllers providers model jsonschema jsonmapper middlewares pipes interceptors authentication hooks exceptions logger upload-files serve-files templating validation response-filters cache passport prisma typeorm mongoose
+---
+
 # Capabilities
 
 Ts.ED is a Node.js and TypeScript framework on top of Express/Koa.js. It provides different platform adapters

diff --git a/docs/introduction/create-your-first-controller.md b/docs/introduction/create-your-first-controller.md
@@ -8,7 +8,7 @@ head:
       content: Create your first controller. Ts.ED is built on top of Express and uses TypeScript language.
   - - meta
     - name: keywords
-      content: controller getting started ts.ed express typescript node.js javascript decorators mvc class models
+      content: first controller getting started ts.ed express typescript node.js javascript decorators mvc class models
 ---
 
 # Create your first controller

diff --git a/docs/introduction/getting-started.md b/docs/introduction/getting-started.md
@@ -1,4 +1,12 @@
 ---
+head:
+  - - meta
+    - name: description
+      content: Start your first Ts.ED project with the CLI or clone a starter project. Ts.ED provides a conventional base structure for your project, making it easy to get started. Choose from a variety of starter projects to find the one that best suits your needs.
+  - - meta
+    - name: keywords
+      content: installation ts.ed framework express koa aws cli di rest graphql typescript node.js bun.js javascript native ESM decorators jsonschema class models providers pipes middlewares testing developer
+
 projects:
   - title: Kit basic
     href: https://github.com/tsedio/tsed-getting-started

diff --git a/docs/introduction/migrate-from-v7.md b/docs/introduction/migrate-from-v7.md
@@ -5,7 +5,7 @@ head:
       content: Migrate Ts.ED application from v7 to v8. Ts.ED is built on top of Express and uses TypeScript language.
   - - meta
     - name: keywords
-      content: migration getting started ts.ed express typescript node.js javascript decorators mvc class models
+      content: migration v7 getting started ts.ed express typescript node.js javascript decorators mvc class models
 ---
 
 # Migrate from v7 to v8
@@ -291,7 +291,7 @@ fs.readFile();
 This import notation works only if have `"esModuleInterop": true` in your tsconfig.json. Otherwhise, use:
 
 ```ts
-import * as fs from "fs-extra"
+import * as fs from "fs-extra";
 ```
 
 :::

diff --git a/docs/introduction/what-is-news-v8.md b/docs/introduction/what-is-news-v8.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: What's new in v8? The latest releases for Ts.ED focus on improved dependency injection that let you access the injector instance everywhere in your code. Notable features in recent pre-releases include support for Apollo 4, the removal of CommonJS support in favor of ECMAScript Modules, enhanced request logging, and additional optimizations to reduce code size.
+  - - meta
+    - name: keywords
+      content: news features v8 ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # What's new in v8 ?
 
 The latest releases for Ts.ED focus on improved dependency injection that let you access the

diff --git a/docs/introduction/what-is-tsed.md b/docs/introduction/what-is-tsed.md
@@ -1,3 +1,13 @@
+---
+head:
+  - - meta
+    - name: description
+      content: Ts.ED is a framework for building server-side and scalable applications for Node.js environment. It's built with TypeScript and uses classes (OOP), decorators and Functional programming to develop your application.
+  - - meta
+    - name: keywords
+      content: discover ts.ed framework express typescript node.js javascript decorators mvc class models providers pipes middlewares testing developer
+---
+
 # What is Ts.ED?
 
 Ts.ED is a framework for building server-side and scalable applications for Node.js environment. It's built with [TypeScript](http://www.typescriptlang.org/) and uses classes (OOP), decorators and Functional programming

diff --git a/docs/tutorials/agenda.md b/docs/tutorials/agenda.md
@@ -1,9 +1,11 @@
 ---
-meta:
-  - name: description
-    content: Use Agenda with Express/Koa, TypeScript and Ts.ED. Agenda, a light-weight job scheduling library for Node.js
-  - name: keywords
-    content: ts.ed express typescript agenda node.js javascript decorators
+head:
+  - - meta
+    - name: description
+      content: Use Agenda with Express/Koa, TypeScript and Ts.ED. Agenda, a light-weight job scheduling library for Node.js
+  - - meta
+    - name: keywords
+      content: ts.ed express typescript agenda node.js javascript decorators
 ---
 
 # Agenda

diff --git a/docs/tutorials/ajv.md b/docs/tutorials/ajv.md
@@ -1,9 +1,11 @@
 ---
-meta:
-  - name: description
-    content: Use AJV with Express, TypeScript and Ts.ED. AJV allows you to validate your data models from a JsonSchema.
-  - name: keywords
-    content: ts.ed express typescript ajv node.js javascript decorators jsonschema class models
+head:
+  - - meta
+    - name: description
+      content: Use AJV with Express, TypeScript and Ts.ED. AJV allows you to validate your data models from a JsonSchema.
+  - - meta
+    - name: keywords
+      content: ts.ed express koa typescript ajv node.js javascript decorators jsonschema class models
 projects:
   - title: Kit basic
     href: https://github.com/tsedio/tsed-getting-started

diff --git a/docs/tutorials/aws.md b/docs/tutorials/aws.md
@@ -1,9 +1,11 @@
 ---
-meta:
-  - name: description
-    content: Guide to deploy your Ts.ED application on AWS.
-  - name: keywords
-    content: ts.ed express typescript aws node.js javascript decorators
+head:
+  - - meta
+    - name: description
+      content: Guide to deploy your Ts.ED application on AWS.
+  - - meta
+    - name: keywords
+      content: ts.ed express typescript aws node.js javascript decorators
 ---
 
 # Serverless HTTP

diff --git a/docs/tutorials/bullmq.md b/docs/tutorials/bullmq.md
@@ -1,9 +1,11 @@
 ---
-meta:
-  - name: description
-    content: Easy to use BullMQ integration for Ts.ED
-  - name: keywords
-    content: ts.ed typescript node.js javascript decorators bullmq
+head:
+  - - meta
+    - name: description
+      content: Easy to use BullMQ integration for Ts.ED. The BullMQ Module for Ts.ED allows you to decorate a class using the `@JobController` decorator and implement the `JobMethods` interface provided by the module. Repeatable Jobs can also be defined using this decorator.
+  - - meta
+    - name: keywords
+      content: ts.ed typescript node.js javascript decorators bullmq
 ---
 
 # BullMQ

diff --git a/docs/tutorials/graphql-apollo.md b/docs/tutorials/graphql-apollo.md
@@ -1,9 +1,11 @@
 ---
-meta:
-  - name: description
-    content: Use Apollo, Nexus or Type-graphql with Ts.ED framework. GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data.
-  - name: keywords
-    content: ts.ed express koa typescript apollo node.js javascript decorators
+head:
+  - - meta
+    - name: description
+      content: Use Apollo, Nexus or Type-graphql with Ts.ED framework. GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data.
+  - - meta
+    - name: keywords
+      content: ts.ed express koa typescript apollo node.js javascript decorators
 ---
 
 # Apollo