Fix docs

yiisoft · May 6, 2024 · f2945b2 · f2945b2
1 parent 9fc3b79
commit f2945b2
Show file tree

Hide file tree

Showing 11 changed files with 63 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ standalone PHP applications.
 
 ## Installation
 
-The package could be installed with composer:
+The package could be installed with [Composer](https://getcomposer.org):
 
 ```shell
 composer require yiisoft/translator
@@ -295,32 +295,13 @@ echo $translator->withDefaultCategory($newDefaultCategoryId);
 
 The package contains interfaces for development of custom formatters, readers, and writers.
 
-## Testing
+## Documentation
 
-### Unit testing
+- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md)
+- [Internals](docs/internals.md)
 
-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
-```
+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).
 
 ## License
 

diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
         "issues": "https://github.com/yiisoft/translator/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/translator"
     },
@@ -67,4 +67,4 @@
         "test": "phpunit --testdox --no-interaction",
         "test-watch": "phpunit-watcher watch"
     }
-}
+}
diff --git a/docs/guide/en/README.md b/docs/guide/en/README.md
@@ -0,0 +1,5 @@
+# Documentation
+
+- [Extractor](extractor.md)
+- [`intl` formatter](intl-formatter.md)
+- [Simple Formatter](simple-formatter.md)
diff --git a/docs/en/extractor.md → docs/guide/en/extractor.md b/docs/en/extractor.md → docs/guide/en/extractor.md
diff --git a/docs/en/intl-formatter.md → docs/guide/en/intl-formatter.md b/docs/en/intl-formatter.md → docs/guide/en/intl-formatter.md
diff --git a/docs/en/simple-formatter.md → docs/guide/en/simple-formatter.md b/docs/en/simple-formatter.md → docs/guide/en/simple-formatter.md
diff --git a/docs/guide/pt-BR/README.md b/docs/guide/pt-BR/README.md
@@ -0,0 +1,5 @@
+# Documentation
+
+- [Extractor](extractor.md)
+- [`intl` formatter](intl-formatter.md)
+- [Simple Formatter](simple-formatter.md)
diff --git a/docs/pt-BR/extractor.md → docs/guide/pt-BR/extractor.md b/docs/pt-BR/extractor.md → docs/guide/pt-BR/extractor.md
diff --git a/docs/pt-BR/intl-formatter.md → docs/guide/pt-BR/intl-formatter.md b/docs/pt-BR/intl-formatter.md → docs/guide/pt-BR/intl-formatter.md
diff --git a/docs/pt-BR/simple-formatter.md → docs/guide/pt-BR/simple-formatter.md b/docs/pt-BR/simple-formatter.md → docs/guide/pt-BR/simple-formatter.md
diff --git a/docs/internals.md b/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
+```