From bbda1fadbdbd181fb54948ec82125c908914c334 Mon Sep 17 00:00:00 2001 From: Serge Kvashnin <75180587+serge-kvashnin@users.noreply.github.com> Date: Fri, 24 May 2024 09:36:48 +0200 Subject: [PATCH] Add description to documentation pages. --- docs/content/guides/cli-command.md | 4 ++-- docs/content/guides/request.md | 4 ++-- docs/content/usage/composition.md | 4 ++-- docs/content/usage/configuration.md | 4 ++-- docs/content/usage/custom-rules.md | 4 ++-- docs/content/usage/normalization.md | 4 ++-- docs/content/usage/rules.md | 4 ++-- docs/content/usage/strict-mode.md | 4 ++-- docs/content/usage/validation-errors.md | 6 +++--- docs/content/usage/validation.md | 4 ++-- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/content/guides/cli-command.md b/docs/content/guides/cli-command.md index 24dfdcb..ccbc007 100644 --- a/docs/content/guides/cli-command.md +++ b/docs/content/guides/cli-command.md @@ -3,13 +3,13 @@ title: "CLI Command" description: "" summary: "" date: 2024-04-24T19:58:35+02:00 -lastmod: 2024-04-24T19:58:35+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 820 toc: true seo: title: "" # custom title (optional) - description: "" # custom description (recommended) + description: "Integrate PHP validation into your Symfony Console commands to validate user-provided command-line arguments." # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true --- diff --git a/docs/content/guides/request.md b/docs/content/guides/request.md index b79e0a4..0b04542 100644 --- a/docs/content/guides/request.md +++ b/docs/content/guides/request.md @@ -3,13 +3,13 @@ title: "HTTP Request" description: "Validating HTTP request payload using validation library." summary: "" date: 2024-04-21T17:45:42+02:00 -lastmod: 2024-04-21T17:45:42+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 810 toc: true seo: title: "" # custom title (optional) - description: "" # custom description (recommended) + description: "This small guide demonstrates how to integrate the validation library with your HTTP API built using a framework that implements PSR-7 request and response interfaces." # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true --- diff --git a/docs/content/usage/composition.md b/docs/content/usage/composition.md index 41c8625..470b5e1 100644 --- a/docs/content/usage/composition.md +++ b/docs/content/usage/composition.md @@ -3,13 +3,13 @@ title: "Composing Rule Sets" description: "" summary: "" date: 2024-04-21T17:45:42+02:00 -lastmod: 2024-04-21T17:45:42+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 150 toc: true seo: title: "" # custom title (optional) - description: "" # custom description (recommended) + description: "Learn how to compose complex validation rules using logical operators (AND/OR), handle optional values, and dynamically create rule sets based on data." # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true --- diff --git a/docs/content/usage/configuration.md b/docs/content/usage/configuration.md index 71dd853..57c3cd0 100644 --- a/docs/content/usage/configuration.md +++ b/docs/content/usage/configuration.md @@ -3,12 +3,12 @@ title: "Configuration" description: "" summary: "" date: 2024-04-21T19:54:40+02:00 -lastmod: 2024-04-21T19:54:40+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 190 toc: true seo: - title: "" # custom title (optional) + title: "Control how your validator handles exceptions and undefined properties. Apply options globally or per validation run." # custom title (optional) description: "" # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true diff --git a/docs/content/usage/custom-rules.md b/docs/content/usage/custom-rules.md index 1e4c13d..88e6ce7 100644 --- a/docs/content/usage/custom-rules.md +++ b/docs/content/usage/custom-rules.md @@ -3,12 +3,12 @@ title: "Custom Rules" description: "" summary: "" date: 2024-04-21T18:51:00+02:00 -lastmod: 2024-04-21T18:51:00+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 140 toc: true seo: - title: "" # custom title (optional) + title: "This page explains how to create custom validation rules by defining rule and validator classes, using optional normalizers, and managing validator dependencies." # custom title (optional) description: "" # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true diff --git a/docs/content/usage/normalization.md b/docs/content/usage/normalization.md index a7d39f2..93f58da 100644 --- a/docs/content/usage/normalization.md +++ b/docs/content/usage/normalization.md @@ -3,12 +3,12 @@ title: "Normalization" description: "" summary: "" date: 2024-04-21T17:45:42+02:00 -lastmod: 2024-04-21T17:45:42+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 160 toc: true seo: - title: "" # custom title (optional) + title: "Access normalized data in validation results after applying transformations for clean and consistent data processing." # custom title (optional) description: "" # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true diff --git a/docs/content/usage/rules.md b/docs/content/usage/rules.md index aae1226..8cfa484 100644 --- a/docs/content/usage/rules.md +++ b/docs/content/usage/rules.md @@ -3,13 +3,13 @@ title: "Rules" description: "" summary: "" date: 2024-04-21T18:34:17+02:00 -lastmod: 2024-04-21T18:34:17+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 130 toc: true seo: title: "" # custom title (optional) - description: "" # custom description (recommended) + description: "This reference provides an overview of built-in validation rules for common data types like email, IP addresses, URLs, and more." # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true --- diff --git a/docs/content/usage/strict-mode.md b/docs/content/usage/strict-mode.md index 98a2e9d..ee030ad 100644 --- a/docs/content/usage/strict-mode.md +++ b/docs/content/usage/strict-mode.md @@ -3,13 +3,13 @@ title: "Strict Mode" description: "" summary: "" date: 2024-04-21T19:44:18+02:00 -lastmod: 2024-04-21T19:44:18+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 180 toc: true seo: title: "" # custom title (optional) - description: "" # custom description (recommended) + description: "This page explains strict mode, which enforces explicit validation rules for all data properties and how to disable it." # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true --- diff --git a/docs/content/usage/validation-errors.md b/docs/content/usage/validation-errors.md index f0cc79c..49d6134 100644 --- a/docs/content/usage/validation-errors.md +++ b/docs/content/usage/validation-errors.md @@ -3,18 +3,18 @@ title: "Validation Errors" description: "" summary: "" date: 2024-04-21T19:33:08+02:00 -lastmod: 2024-04-21T19:33:08+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 170 toc: true seo: title: "" # custom title (optional) - description: "" # custom description (recommended) + description: "Handle PHP validation errors by either catching thrown exceptions for immediate feedback or aggregating violations for comprehensive error reporting." # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true --- -The `validate()` method offers flexibility in how validation errors are handled. Here's how to work with the different +The `validate()` method offers flexibility in how validation errors are handled. Here's how to work with the different modes. ## Throwing Exceptions (Default Behavior) diff --git a/docs/content/usage/validation.md b/docs/content/usage/validation.md index 31bd8f7..f0f4701 100644 --- a/docs/content/usage/validation.md +++ b/docs/content/usage/validation.md @@ -3,13 +3,13 @@ title: "Validation" description: "" summary: "" date: 2024-04-21T17:45:42+02:00 -lastmod: 2024-04-21T17:45:42+02:00 +lastmod: 2024-05-23T19:58:35+02:00 draft: false weight: 120 toc: true seo: title: "" # custom title (optional) - description: "" # custom description (recommended) + description: "Learn how to validate single values, arrays, objects, and collections." # custom description (recommended) canonical: "" # custom canonical URL (optional) noindex: false # false (default) or true ---