Docs folder standardization and other fixes

LICENSE.md

@@ -1,17 +1,17 @@
-Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
+Copyright © 2008 by Yii Software (<https://www.yiiframework.com/>)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
- * Redistributions of source code must retain the above copyright
+* Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
+* Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
- * Neither the name of Yii Software nor the names of its
+* Neither the name of Yii Software nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.
 

README.md

@@ -29,26 +29,17 @@ The package could be installed with composer:
 composer require yiisoft/yii-runner-roadrunner
 ```
 
-## Documentation
-
-- [English](docs/en/README.md)
-- [Russian](docs/ru/README.md)
-
 ## General usage
 
 Get RoadRunner:
 
-```
+```shell
 ./vendor/bin/rr get
 ```
 
 Create `worker.php` in your application root directory:
 
 ```php
-<?php
-
-declare(strict_types=1);
-
 use Yiisoft\Yii\Runner\RoadRunner\RoadRunnerHttpApplicationRunner;
 
 ini_set('display_errors', 'stderr');
@@ -99,7 +90,7 @@ logs:
 
 Run RoadRunner with the config specified:
 
-```
+```shell
 ./rr serve
 ```
 
@@ -195,39 +186,15 @@ You can also use your own implementation of the `Spiral\RoadRunner\Http\PSR7Work
 $runner = $runner->withPsr7Worker($psr7Worker);
 ```
 
-## Testing
-
-### Unit testing
-
-The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
-
-```shell
-./vendor/bin/phpunit
-```
-
-### 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:
-
-```shell
-./vendor/bin/roave-infection-static-analysis-plugin
-```
-
-### Static analysis
-
-The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
-
-```shell
-./vendor/bin/psalm
-```
+## Documentation
 
-## License
+- [Guide](docs/guide/readme.md)
+- [Internals](docs/internals.md)
 
-The Yii RoadRunner Runner is free software. It is released under the terms of the BSD License.
-Please see [`LICENSE`](./LICENSE.md) for more information.
+## Support
 
-Maintained by [Yii Software](https://www.yiiframework.com/).
+If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
+You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
 
 ## Support the project
 
@@ -240,3 +207,10 @@ Maintained by [Yii Software](https://www.yiiframework.com/).
 [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
 [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
 [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
+
+## License
+
+The Yii RoadRunner Runner is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
+
+Maintained by [Yii Software](https://www.yiiframework.com/).

composer.json

@@ -12,7 +12,7 @@
         "issues": "https://github.com/yiisoft/yii-runner-roadrunner/issues?state=open",
         "forum": "https://www.yiiframework.com/forum/",
         "wiki": "https://www.yiiframework.com/wiki/",
-        "irc": "irc://irc.freenode.net/yii",
+        "irc": "ircs://irc.libera.chat:6697/yii",
         "chat": "https://t.me/yii3en",
         "source": "https://github.com/yiisoft/yii-runner-roadrunner"
     },

docs/pt-BR/grpc-application-runner.md → docs/guide/pt-BR/grpc-application-runner.md

@@ -54,4 +54,4 @@ grpc:
         command: "php GrpcWorker.php"
 ```
 
-> Aviso! Se você também estiver implementando o lado do cliente (para chamar a API RoadRunner do aplicativo PHP), você precisará adicionar manualmente o pacote `grpc/grpc` da versão correta ao seu compositor.json.
+> Aviso! Se você também estiver implementando o lado do cliente (para chamar a API RoadRunner do aplicativo PHP), você precisará adicionar manualmente o pacote `grpc/grpc` da versão correta ao seu composer.json.

docs/guide/readme.md

@@ -0,0 +1,6 @@
+# Yii RoadRunner Runner
+
+- [English](en/readme.md)
+- [Português - Brasil](pt-BR/readme.md)
+- [Русский](ru/readme.md)
+- [Internals](../internals.md)

docs/internals.md

@@ -0,0 +1,45 @@
+# Internals
+
+## Unit testing
+
+The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+
+```shell
+./vendor/bin/phpunit
+```
+
+## 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:
+
+```shell
+./vendor/bin/roave-infection-static-analysis-plugin
+```
+
+## Static analysis
+
+The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
+
+```shell
+./vendor/bin/psalm
+```
+
+## 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:
+
+```shell
+./vendor/bin/rector
+```
+
+## Composer require checker
+
+This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.
+
+To run the checker, execute the following command:
+
+```shell
+./vendor/bin/composer-require-checker
+```