doc: Improvements & fixes.

LastDragon-ru · Jan 21, 2024 · 9a52ac3 · 9a52ac3
1 parent 53104e7
commit 9a52ac3
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -119,17 +119,17 @@ Please follow [Upgrade Guide](UPGRADE.md).
 
 # Legend
 
-| Icon | Place     | Description                                                      |
-|:----:|:----------|------------------------------------------------------------------|
-|  🧪  | Docs      | Experimental feature. Any feedback would be greatly appreciated. |
-|  🐝  | Docs      | Package intended to use in dev.                                  |
-|  🤝  | Changelog | Backward-compatible change.                                      |
-|  🡹  | CI        | The highest versions of dependencies are used.                   |
-|  🔒  | CI        | The locked versions of dependencies are used.                    |
-|  🡻  | CI        | The lowest versions of dependencies are used.                    |
-|  🪓  | CI        | The optional dependencies are removed.                           |
-|  🆄  | CI        | Running on Ubuntu                                                |
-|  🆆  | CI        | Running on Windows                                               |
-|  🅼  | CI        | Running on Mac OS X                                              |
+| Icon | Place | Description                                                      |
+|:----:|:------|------------------------------------------------------------------|
+|  🧪  | Docs  | Experimental feature. Any feedback would be greatly appreciated. |
+|  🐝  | Docs  | Package intended to use in dev.                                  |
+|  🤝  | Docs  | Backward-compatible change.                                      |
+|  🡹  | CI    | The highest versions of dependencies are used.                   |
+|  🔒  | CI    | The locked versions of dependencies are used.                    |
+|  🡻  | CI    | The lowest versions of dependencies are used.                    |
+|  🪓  | CI    | The optional dependencies are removed.                           |
+|  🆄  | CI    | Running on Ubuntu                                                |
+|  🆆  | CI    | Running on Windows                                               |
+|  🅼  | CI    | Running on Mac OS X                                              |
 
 [//]: # (end: a974316bcb5b40e0fcedb0c38b2c3c43c80c2cadfbf95a8caf27d6f163abff0d)
diff --git a/docs/Legend.md b/docs/Legend.md
@@ -1,14 +1,14 @@
 # Legend
 
-| Icon | Place     | Description                                                      |
-|:----:|:----------|------------------------------------------------------------------|
-|  🧪  | Docs      | Experimental feature. Any feedback would be greatly appreciated. |
-|  🐝  | Docs      | Package intended to use in dev.                                  |
-|  🤝  | Changelog | Backward-compatible change.                                      |
-|  🡹  | CI        | The highest versions of dependencies are used.                   |
-|  🔒  | CI        | The locked versions of dependencies are used.                    |
-|  🡻  | CI        | The lowest versions of dependencies are used.                    |
-|  🪓  | CI        | The optional dependencies are removed.                           |
-|  🆄  | CI        | Running on Ubuntu                                                |
-|  🆆  | CI        | Running on Windows                                               |
-|  🅼  | CI        | Running on Mac OS X                                              |
+| Icon | Place | Description                                                      |
+|:----:|:------|------------------------------------------------------------------|
+|  🧪  | Docs  | Experimental feature. Any feedback would be greatly appreciated. |
+|  🐝  | Docs  | Package intended to use in dev.                                  |
+|  🤝  | Docs  | Backward-compatible change.                                      |
+|  🡹  | CI    | The highest versions of dependencies are used.                   |
+|  🔒  | CI    | The locked versions of dependencies are used.                    |
+|  🡻  | CI    | The lowest versions of dependencies are used.                    |
+|  🪓  | CI    | The optional dependencies are removed.                           |
+|  🆄  | CI    | Running on Ubuntu                                                |
+|  🆆  | CI    | Running on Windows                                               |
+|  🅼  | CI    | Running on Mac OS X                                              |
diff --git a/packages/graphql/defaults/config.php b/packages/graphql/defaults/config.php
@@ -9,7 +9,8 @@
  * GraphQL Settings
  * -----------------------------------------------------------------------------
  *
- * Note: You need to clear/rebuild the cached schema and IDE helper files after change.
+ * Note: You need to clear/rebuild the cached schema and IDE helper files after
+ * changing any of the settings.
  *
  * @see https://lighthouse-php.com/master/api-reference/commands.html#clear-cache
  * @see https://lighthouse-php.com/master/api-reference/commands.html#ide-helper
@@ -55,8 +56,6 @@
          * types here. Note that directives is the recommended way and have
          * priority over the array. Please see the documentation for more
          * details.
-         *
-         * @see ../README.md#type-operators
          */
         'operators' => [
             // empty
@@ -75,8 +74,6 @@
          * types here. Note that directives is the recommended way and have
          * priority over the array. Please see the documentation for more
          * details.
-         *
-         * @see ../README.md#operators-1
          */
         'operators' => [
             // empty

diff --git a/packages/migrator/README.md b/packages/migrator/README.md
@@ -2,8 +2,9 @@
 
 This package improves standard laravel migrations to add support for raw SQL files during migration and seeding. So you can easily use your favorite visual tool for database development like [MySQL Workbench](https://www.mysql.com/products/workbench/) with Laravel 🥳
 
-| :warning: | The Migrator uses the same mechanism as [Squashing Migrations](https://laravel.com/docs/migrations#squashing-migrations) so not all databases are supported, please see Laravel Documentation for more details. |
-|:---------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+> [!IMPORTANT]
+>
+> The Migrator uses the same mechanism as [Squashing Migrations](https://laravel.com/docs/migrations#squashing-migrations) so not all databases are supported, please see Laravel Documentation for more details.
 
 [include:exec]: <../../dev/artisan lara-asp-documentator:requirements>
 [//]: # (start: 876a9177c0e8e3722ac84e8f3888245fc9070a64a87dedfe7c9d9ba2a13b374b)

diff --git a/packages/testing/README.md b/packages/testing/README.md
@@ -107,8 +107,9 @@ Enables query log for the test case.
 
 # Assertions
 
-| :warning: | By default package overrides scalar comparator to make it strict! So `assertEquals(true, 1)` is `false`. |
-|:---------:|:---------------------------------------------------------------------------------------------------------|
+> [!IMPORTANT]
+>
+> By default, package overrides scalar comparator to make it strict! So `assertEquals(true, 1)` is `false`.
 
 ## General
 
@@ -478,7 +479,7 @@ Providers:
     ['expected d', 'value d'],
     ['expected e', 'value e'],
 ]
- *
+
 Merged:
 [
     '0 / 0 / 0' => ['expected d', 'value a', 'value b', 'value d'],