docs: correct spelling mistakes and other issues, improve syntax

ace-of-aces · ace-of-aces · commit 4c6d2c6258d6 · 2025-09-06T16:30:00.000+02:00
diff --git a/docs/pages/available-options.md b/docs/pages/available-options.md
@@ -6,7 +6,7 @@ These are the options that can be used to transform images with this package.
 
 `string`
 
-Set the background color of the image.  
+Set the background color of the image.
 Any valid HEX color value (without a leading `#`).
 
 Example:
@@ -38,7 +38,7 @@ blur=50
 
 `integer`
 
-Set the contrast level of the image.  
+Set the contrast level of the image.
 Possible values: `-100` to `100`.
 
 Example:
@@ -51,7 +51,7 @@ contrast=50
 
 `string`
 
-Flip the image.  
+Flip the image.
 Possible values: `h` (horizontal), `v` (vertical), `hv` (horizontal and vertical).
 
 Example:
@@ -64,7 +64,7 @@ flip=h
 
 `string`
 
-Set the format of the image.  
+Set the format of the image.
 Supported formats: `jpg`, `jpeg`, `png`, `gif`, `webp`.
 
 Example:
@@ -77,7 +77,7 @@ format=webp
 
 `integer`
 
-Set the height of the image.  
+Set the height of the image.
 Values greater than the original height will be ignored.
 
 Example:
@@ -90,7 +90,7 @@ height=250
 
 `integer`
 
-Set the quality of the image.  
+Set the quality of the image.
 Possible values: `0` to `100`.
 
 Example:
@@ -103,7 +103,7 @@ quality=80
 
 `integer`
 
-Version number of the image.  
+Version number of the image.
 Any positive integer. More info in the [Image Caching](/image-caching) section.
 
 Example:
@@ -116,7 +116,7 @@ version=2
 
 `integer`
 
-Set the width of the image.  
+Set the width of the image.
 Values greater than the original width will be ignored.
 
 Example:
diff --git a/docs/pages/cdn-usage.md b/docs/pages/cdn-usage.md
@@ -2,7 +2,7 @@
 
 The package is designed to work seamlessly with CDNs like Cloudflare, BunnyCDN, and others.
 
-The most important configuration is the [`Cache-Control`](https://developer.mozilla.org/de/docs/Web/HTTP/Reference/Headers/Cache-Control) header, which you can customize to your liking in the `image-transform-url.php` configuration file.
+The most important configuration is the [`Cache-Control`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control) header, which you can customize in the `image-transform-url.php` configuration file.
 
 ```php
 /*
diff --git a/docs/pages/configuring-options.md b/docs/pages/configuring-options.md
@@ -1,6 +1,6 @@
 # Configuring Options
 
-This package supports a variety of options, but you may not need or want to use all of them. You can configure which options are enabled in the `image-transform-url.php` configuration file.
+This package supports a variety of options, but you may not need all of them. You can configure which options are enabled in the `image-transform-url.php` configuration file.
 
 ```php
 /*
diff --git a/docs/pages/error-handling.md b/docs/pages/error-handling.md
@@ -1,22 +1,22 @@
 # Error Handling
 
-The route handler of this package is designed to be robust against invalid options, paths and file names, while also not exposing additional information of your applications public directory structure.
+The route handler of this package is designed to be robust against invalid options, paths, and file names, while also not exposing additional information about your application's public directory structure.
 
 ## HTTP Status Codes
 
-This is why the route handler will return a plain `404` response if:
+For this reason, the route handler returns a plain `404` response if:
 
--   a requested image does not exist at the specified path
--   the requested image is not a valid image file
+-   the requested image does not exist at the specified path
+-   the requested file is not a valid image
 -   the provided options are not in the correct format (`key=value`, no trailing comma, etc.)
 
 The only two other HTTP errors that can be returned are:
 - a `429` response, which indicates that the request was rate-limited
-- a `403` response, which indicates that the request was unauthorized (e.g. when using signed URLs and the signature is invalid or expired)
+- a `403` response, which indicates that the request was unauthorized (e.g., when using signed URLs and the signature is invalid or expired)
 
 ## Invalid options
 
-If parts of the given route options are invalid, the route handler will ignore them and only apply the valid options.
+If parts of the given route options are invalid, the route handler ignores them and applies only the valid options.
 
 Example:
 
diff --git a/docs/pages/getting-started.md b/docs/pages/getting-started.md
@@ -17,15 +17,15 @@ For example:
 http://[96mlocalhost:8000[39m/[31mimage-transform[39m/[94mwidth=250,quality=80,format=webp[39m/[93mfoo/bar/example.jpg
 ```
 
-With a `source-directory`, respectively:
+With a `source-directory`:
 
 ```ansi
 http://[96mlocalhost:8000[39m/[31mimage-transform[39m/[95mimages[39m/[94mwidth=250,quality=80,format=webp[39m/[93mfoo/bar/example.jpg
 ```
 
 ## Programmatic URL Generation
 
-While you can construct URLs manually when you need it, the package provides convenient methods to generate transformation URLs programmatically using the `ImageTransformUrl` facade.
+While you can construct URLs manually when needed, the package provides convenient methods to generate transformation URLs programmatically using the `ImageTransformUrl` facade.
 
 Use the `make()` method to generate regular transformation URLs:
 
diff --git a/docs/pages/image-caching.md b/docs/pages/image-caching.md
@@ -1,9 +1,9 @@
 # Image Caching
 
-This package comes with the default option to automatically store and serve images statically for the requested options within the caching lifetime.
+This package can automatically store and serve images statically for the requested options within the caching lifetime.
 
 > [!INFO]
-> Having this feature enabled (default behavior) will help to reduce the load on your server and speed up image delivery.
+> Enabling this feature (default) reduces server load and speeds up image delivery.
 
 The processed images are stored in the `storage/app/private/_cache/image-transform-url` directory by default. You can change the disk configuration in the `image-transform-url.php` configuration file.
 
@@ -12,19 +12,19 @@ The processed images are stored in the `storage/app/private/_cache/image-transfo
 >
 > **Source images are considered to be stale content by their file name and path.**
 
-If the content of an original source image changes, but the file name stays the same, the cached images will not be updated automatically until the cache expires.
+If the content of a source image changes but the file name stays the same, the cached images will not be updated automatically until the cache expires.
 To force a revalidation, you can either:
 
 1.  change the image's file name
 2.  move it into another subdirectory, which will change its path
-3.  change the [version number](/available-options#version) in the options (e.g. `version=2`)
+3.  change the [version number](/available-options#version) in the options (e.g., `version=2`)
 4.  or flush the entire cache of your application using the `php artisan cache:clear` command.
 
 ## Cache Size Limit
 
-The image caching feature also comes with a size limit to prevent the cache from growing indefinitely. The default maximum size is set to **100 MB**, but you can change this in the configuration file.
+The image caching feature also includes a size limit to prevent the cache from growing indefinitely. The default maximum size is **100 MB**, but you can change this in the configuration file.
 
-When the cache reaches the specified size limit, it will automatically clean up old files to make space for new ones.
+When the cache reaches the specified size limit, it automatically cleans up old files to make space for new ones.
 
 You may also configure the percentage of the maximum size that should be kept after cleanup, referred to as `clear_to_percent`.
 For example, if `clear_to_percent` is set to 80, 20% of the cache is cleared on each cleanup run, and 80% is retained. The default is set to 80% of the maximum size.
diff --git a/docs/pages/index.md b/docs/pages/index.md
@@ -15,11 +15,11 @@ hero:
 
 features:
     - title: ✈️ On-the-fly
-      details: Use URL parameters to transform images on the fly
+      details: Transform images on the fly via URL parameters
     - title: 🔧 Versatile
-      details: Support various transformations, S3 storage and signed URLs
+      details: Supports various transformations, S3 storage, and signed URLs
     - title: ⚡ Fast and Efficient
-      details: Automatic caching of transformed images for faster loading times
+      details: Automatic caching of transformed images for faster load times
     - title: 🌍 CDN Ready
-      details: Easy integration with CDNs for even faster global delivery
+      details: Easy CDN integration for faster global delivery
 ---
diff --git a/docs/pages/installation.md b/docs/pages/installation.md
@@ -7,7 +7,7 @@
 -   [GD](https://www.php.net/manual/en/book.image.php) or [Imagick](https://www.php.net/manual/en/book.imagick.php) PHP extension installed and [enabled](#driver-configuration)
 
 ::: tip
-If you want to use the file caching feature (highly recommended), a configured `Storage` disk and a `Cache` driver is required. More info in the [Image Caching](/image-caching) section.
+If you want to use the file caching feature (highly recommended), a configured `Storage` disk and a `Cache` driver are required. More info in the [Image Caching](/image-caching) section.
 :::
 
 ## Installation
@@ -26,7 +26,7 @@ php artisan vendor:publish --tag="image-transform-url-config"
 
 ## Driver Configuration
 
-To use Imagick instead of the default GD library for image processing (recommended for performance), you will have to [change the default image driver](https://image.intervention.io/v3/getting-started/frameworks#application-wide-configuration) for the underlying [Intervention Image](https://image.intervention.io/) package.
+To use Imagick instead of the default GD library for image processing (recommended for performance), you must [change the default image driver](https://image.intervention.io/v3/getting-started/frameworks#application-wide-configuration) for the underlying [Intervention Image](https://image.intervention.io/) package.
 
 ::: info
 The [`libvips` driver](https://github.com/Intervention/image-driver-vips) is currently not supported.
@@ -36,11 +36,11 @@ The [`libvips` driver](https://github.com/Intervention/image-driver-vips) is cur
 
 Depending on your environment, you may need to adjust some `php.ini` settings.
 
-1. If you are using the default GD driver, be aware that it can use alot more RAM than regular web requests. It's highly recommended to set your memory limit to *at least* 256MB.
+1. If you are using the default GD driver, be aware that it can use alot more RAM than regular web requests. It's highly recommended to set your memory limit to *at least* 256 MB.
 ```
 memory_limit=512M
 ```
-2. If you have the [Swoole extension](https://laravel.com/docs/octane#swoole) installed, make sure you have the following setting to [avoid conflicts](https://github.com/ace-of-aces/laravel-image-transform-url/issues/4) with Laravel's `defer` helper which this package uses.
+2. If you have the [Swoole extension](https://laravel.com/docs/octane#swoole) installed, ensure you have the following setting to [avoid conflicts](https://github.com/ace-of-aces/laravel-image-transform-url/issues/4) with Laravel's `defer` helper, which this package uses.
 ```
 swoole.use_shortname=off
 ```
diff --git a/docs/pages/rate-limiting.md b/docs/pages/rate-limiting.md
@@ -1,21 +1,21 @@
 # Rate Limiting
 
-Another feature of this package is the ability to limit the number of transformations that the image transformation route should process **per path and IP address** within a given time frame.
+This package can limit the number of transformations the image transformation route processes **per path and IP address** within a given time frame.
 
-The rate limit will come into effect for new transformation requests only, and will not affect previously cached images.
+The rate limit applies only to new transformation requests and does not affect previously cached images.
 
-By default, rate limiting is disabled for the `local` and `testing` app environements to not distract you when developing your app. You can configure the rate limit settings in the `image-transform-url.php` configuration file.
+By default, rate limiting is disabled for the `local` and `testing` app environments so it doesn't distract you during development. You can configure the rate limit settings in the `image-transform-url.php` configuration file.
 
 ```php
 /*
 |--------------------------------------------------------------------------
 | Rate Limit
 |--------------------------------------------------------------------------
 |
-| Below you may configure the rate limit which is applied for each image
-| new transformation by the path and IP address. It is recommended to
-| set this to a low value, e.g. 2 requests per minute, to prevent
-| abuse.
+| Below you may configure the rate limit applied to each image transformation
+| by path and IP address. It is recommended to set this to a low value,
+| e.g. 2 requests per minute, to prevent abuse.
+|
 */
 'rate_limit' => [
     'enabled' => env('IMAGE_TRANSFORM_RATE_LIMIT_ENABLED', true),
diff --git a/docs/pages/s3-usage.md b/docs/pages/s3-usage.md
@@ -1,13 +1,13 @@
 # Usage with S3
 
 This guide explains how to configure this package to work with S3-compatible storage services like AWS S3 or Cloudflare R2.
-This enables you to transform and serve images stored remotely without the need to store images on your local server.
+This lets you transform and serve images stored remotely without the need to store them on your local server.
 
-1. Set up your S3 disk in your [filesystems configuration](https://laravel.com/docs/filesystem#amazon-s3-compatible-filesystems), install the [S3 package](https://laravel.com/docs/filesystem#s3-driver-configuration) and ensure you have the necessary credentials and settings for your S3 bucket. Public bucket access is not required.
+1. Set up your S3 disk in your [filesystems configuration](https://laravel.com/docs/filesystem#amazon-s3-compatible-filesystems), install the [S3 package](https://laravel.com/docs/filesystem#s3-driver-configuration), and ensure you have the necessary credentials and settings for your S3 bucket. Public bucket access is not required.
 
 2. Configure the package via `image-transform-url.php` to include your S3 disk in the `source_directories` as described in [the setup guide](/setup#configuring-remote-sources).
 
-3. If you are using the [Image Caching](/image-caching) feature and want to store transformed images back to your S3 bucket instead of your local filesystem, you may also set the `cache.disk` option in the `image-transform-url.php` configuration file to your S3 disk.
+3. If you are using the [Image Caching](/image-caching) feature and want to store transformed images back to your S3 bucket instead of your local filesystem, set the `cache.disk` option in the `image-transform-url.php` configuration file to your S3 disk.
 
 ```php
 'cache' => [
diff --git a/docs/pages/setup.md b/docs/pages/setup.md
@@ -1,8 +1,8 @@
 # Setup
 
-1. Configure the package via `image-transform-url.php` to set your `source_directories`, from where you want to transform the images. By default, the package will look for `images` directories in your `public` folder and in the `storage/app/public` directory.
+1. Configure the package via `image-transform-url.php` to set your `source_directories`, from where you want to transform the images. By default, the package looks for `images` directories in your `public` folder and in the `storage/app/public` directory.
 
-2. Choose a default source directory by setting the `default_source_directory` option in the `image-transform-url.php` configuration file. This will be used if no source directory is specified in the URL.
+2. Choose a default source directory by setting the `default_source_directory` option in the `image-transform-url.php` configuration file. This is used if no source directory is specified in the URL.
 
 > [!TIP]
 > It is recommended to use dedicated subdirectories for your images in order to avoid conflicts with other files.
@@ -45,7 +45,8 @@ An example source directory configuration might look like this:
 ```
 
 ## Configuring Remote Sources
-If you want to use a remote source (like AWS S3 or Cloudflare R2) as a source directory, you can configure any [Laravel Filesystem disk](https://laravel.com/docs/filesystem#configuration) in your `config/filesystems.php` file and then reference it in the `source_directories` configuration.
+
+If you want to use a remote source (like AWS S3 or Cloudflare R2) as a source directory, you may configure any [Laravel Filesystem disk](https://laravel.com/docs/filesystem#configuration) in your `config/filesystems.php` file and then reference it in the `source_directories` configuration.
 
 ```php
 'source_directories' => [
@@ -57,4 +58,4 @@ If you want to use a remote source (like AWS S3 or Cloudflare R2) as a source di
 ],
 ```
 
-Read the [full guide on how to use this package with S3](/s3-usage.md).
+Read the [full guide on how to use this package with S3](/s3-usage).
diff --git a/docs/pages/signed-urls.md b/docs/pages/signed-urls.md
@@ -2,22 +2,22 @@
 
 This package provides the option to generate signed URLs for images from specific source directories powered by [Laravel's URL signing feature](https://laravel.com/docs/urls#signed-urls).
 
-This can be useful for securing access to images that should not be publicly accessible without proper authorization or only in a scaled down version.
+This can be useful for securing access to images that should not be publicly accessible without proper authorization or should only be available in a scaled-down version.
 
 ::: info
 Signed URLs also ensure that the provided options cannot be modified client-side.
 :::
 
 ::: warning
-The Signed URL feature does not restrict access to public images.
+The signed URL feature does not restrict access to public images.
 If you want to secure access to images, ensure that the source directories you want signed URLs for are not publicly accessible.
 :::
 
 ## Setup
 
 To enable signed URLs, set the `signed_urls.enabled` option to `true` in your `image-transform-url.php` configuration.
 
-You then need to specify the source directories for which signed URLs should apply to in the `signed_urls.source_directories` array.
+You then need to specify the source directories to which signed URLs should apply in the `signed_urls.for_source_directories` array.
 
 For example:
 
@@ -32,7 +32,7 @@ For example:
 'signed_urls' => [
     'enabled' => env('IMAGE_TRANSFORM_SIGNED_URLS_ENABLED', false),
     'for_source_directories' => env('IMAGE_TRANSFORM_SIGNED_URLS_FOR_SOURCE_DIRECTORIES', [
-        'protected-images',
+        'protected',
     ]),
 ],
 ```
@@ -46,7 +46,7 @@ use AceOfAces\LaravelImageTransformUrl\Facades\ImageTransformUrl;
 
 $options = [
     'blur' => 50,
-    'width' 500,
+    'width' => 500,
 ];
 
 $blurredImage = ImageTransformUrl::signedUrl(
@@ -58,14 +58,14 @@ $blurredImage = ImageTransformUrl::signedUrl(
 
 ## Temporary Signed URLs
 
-If you would like to to generate a signed URL that expires after a certain time, you can use the `temporarySignedUrl` method:
+If you would like to generate a signed URL that expires after a certain time, you can use the `temporarySignedUrl` method:
 
 ```php
 use AceOfAces\LaravelImageTransformUrl\Facades\ImageTransformUrl;
 
 $options = [
     'blur' => 50,
-    'width' 500,
+    'width' => 500,
 ];
 
 $temporarySignedUrl = ImageTransformUrl::temporarySignedUrl(
@@ -77,6 +77,5 @@ $temporarySignedUrl = ImageTransformUrl::temporarySignedUrl(
 ```
 
 ::: info
-You can also use the generic `signedUrl` method to generate temporary signed URLs.
-This method accepts an `$expiration` parameter, which defaults to `null`. If you provide a value, it will generate a temporary signed URL.
+You can also use the generic `signedUrl` method to generate temporary signed URLs. This method accepts an `$expiration` parameter, which defaults to `null`. If you provide a value, it generates a temporary signed URL.
 :::
