Docs folder standardization and other fixes

yiisoft · Apr 15, 2024 · 2352dce · 2352dce
1 parent 583c28b
commit 2352dce
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 47 deletions.
diff --git a/docs/en/internals.md b/docs/en/internals.md
diff --git a/docs/en/usage-standalone.md → docs/guide/en/usage-standalone.md b/docs/en/usage-standalone.md → docs/guide/en/usage-standalone.md
diff --git a/docs/en/usage-with-symfony.md → docs/guide/en/usage-with-symfony.md b/docs/en/usage-with-symfony.md → docs/guide/en/usage-with-symfony.md
diff --git a/docs/en/usage-with-yii-console.md → docs/guide/en/usage-with-yii-console.md b/docs/en/usage-with-yii-console.md → docs/guide/en/usage-with-yii-console.md
diff --git a/docs/en/testing.md → docs/internals.md b/docs/en/testing.md → docs/internals.md
@@ -1,4 +1,4 @@
-# Testing
+# Internals
 
 This package can be tested globally or individually for each DBMS.
 
@@ -28,13 +28,17 @@ in the root directory of each package.
 
 For running the Docker containers, you can use the following command:
 
-```shell
+```dockerfile
 docker compose up -d
 ```
 
 ## Unit testing
 
-The package is tested with [PHPUnit](https://phpunit.de/).
+The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+
+```shell
+./vendor/bin/phpunit
+```
 
 ### Global testing
 
@@ -68,7 +72,7 @@ Suites available:
 - Pgsql
 - Sqlite
 
-### Mutation testing
+## Mutation testing
 
 The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
 [Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
@@ -87,15 +91,17 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
 
 ## Rector
 
-Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either newest or any specific version of PHP: 
+Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
+use either newest or any specific version of PHP:
 
 ```shell
 ./vendor/bin/rector
 ```
 
-## Composer require checker
+## Dependencies
 
-This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.
+Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive
+[Composer](https://getcomposer.org/) dependencies.
 
 To run the checker, execute the following command: