Docs folder standardization and other fixes (#250)

yiisoft · Apr 22, 2024 · 3d122c5 · 3d122c5
1 parent 9b140ac
commit 3d122c5
Show file tree

Hide file tree

Showing 44 changed files with 1,629 additions and 71 deletions.
diff --git a/LICENSE.md b/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.
 

diff --git a/README.md b/README.md
@@ -2,16 +2,14 @@
     <a href="https://github.com/yiisoft" target="_blank">
         <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px">
     </a>
-    <h1 align="center">Debug Extension for Yii</h1>
+    <h1 align="center">Yii Debug Extension</h1>
     <br>
 </p>
 
 This extension provides a debugger for [Yii framework](https://www.yiiframework.com) applications. When this extension is used,
 a debugger toolbar will appear at the bottom of every page. The extension also provides
 a set of standalone pages to display more detailed debug information.
 
-For license information check the [LICENSE](LICENSE.md)-file.
-
 [![Latest Stable Version](https://poser.pugx.org/yiisoft/yii-debug/v/stable.png)](https://packagist.org/packages/yiisoft/yii-debug)
 [![Total Downloads](https://poser.pugx.org/yiisoft/yii-debug/downloads.png)](https://packagist.org/packages/yiisoft/yii-debug)
 [![Build status](https://github.com/yiisoft/yii-debug/workflows/build/badge.svg)](https://github.com/yiisoft/yii-debug/actions?query=workflow%3Abuild)
@@ -21,20 +19,18 @@ For license information check the [LICENSE](LICENSE.md)-file.
 [![static analysis](https://github.com/yiisoft/yii-debug/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-debug/actions?query=workflow%3A%22static+analysis%22)
 [![type-coverage](https://shepherd.dev/github/yiisoft/yii-debug/coverage.svg)](https://shepherd.dev/github/yiisoft/yii-debug)
 
-Installation
-------------
+## Installation
 
 The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
 
-```
+```shell
 composer require yiisoft/yii-debug --dev
 ```
 
 > The debug extension also can be installed without the `--dev` flag if you want to collect data in production.
 > Specify needed collectors only to reduce functions overriding and improve performance.
 
-Usage
------
+## Usage
 
 Once the extension is installed, modify your `config/common/params.php` as follows:
 
@@ -52,39 +48,20 @@ All included collectors start listen and collect payloads from each HTTP request
 Install both [`yiisoft/yii-debug-api`](https://github.com/yiisoft/yii-debug-api) and [`yiisoft/yii-dev-panel`](https://github.com/yiisoft/yii-dev-panel)
 to be able to interact with collected data through UI.
 
-### Documentation
-
-[English](docs/en/README.md)
-
-### 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. To run it:
-
-```shell
-./vendor/bin/infection
-```
+## Documentation
 
-### Static analysis
+- [Guide](docs/guide/README.md)
 
-The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
+## Support
 
-```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).
 
-### Support the project
+## Support the project
 
 [![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
 
-### Follow updates
+## Follow updates
 
 [![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
 [![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
@@ -94,7 +71,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
 
 ## License
 
-The Debug Extension for Yii is free software. It is released under the terms of the BSD License.
+The Yii Debug Extension 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/).
diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
         "issues": "https://github.com/yiisoft/yii-debug/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-debug"
     },

diff --git a/docs/en/README.md b/docs/en/README.md
diff --git a/docs/guide/README.md b/docs/guide/README.md
@@ -0,0 +1,5 @@
+# Yii Debug Extension
+
+- [English](en/README.md)
+- [Português - Brasil](pt-BR/README.md)
+- [Internals](../internals.md)
diff --git a/docs/guide/en/README.md b/docs/guide/en/README.md
@@ -0,0 +1,34 @@
+# Documentation
+
+## Configuration
+
+- [Filtering requests and console commands](filtering.md)
+- [Logging storage](logging.md)
+
+## Collectors
+
+- [Main concept](collector.md)
+- [Summary collectors](collector/summary.md)
+- [Service Collector](collector/service.md)
+- [VarDumper Collector](collector/var-dumper.md)
+- [Log Collector](collector/logger.md)
+- [Event Collector](collector/event-dispatcher.md)
+- [HttpClient Collector](collector/http-client.md)
+- [Exception Collector](collector/exception.md)
+
+### Web collectors
+
+- [Middleware Collector](collector/web/middleware.md)
+- [Request Collector](collector/web/request.md)
+- [WebAppInfo Collector](collector/web/web-app-info.md)
+
+### Console collectors
+
+- [Command Collector](collector/console/command.md)
+- [ConsoleAppInfo Collector](collector/console/console-app-info.md)
+
+## Console commands
+
+- [`debug:reset`](command-reset.md)
+- [`debug:container`](command-container.md)
+- [`debug:events`](command-events.md)
diff --git a/docs/en/collector.md → docs/guide/en/collector.md b/docs/en/collector.md → docs/guide/en/collector.md
diff --git a/docs/en/collector/console/command.md → docs/guide/en/collector/console/command.md b/docs/en/collector/console/command.md → docs/guide/en/collector/console/command.md
diff --git a/.../en/collector/console/console-app-info.md → .../en/collector/console/console-app-info.md b/.../en/collector/console/console-app-info.md → .../en/collector/console/console-app-info.md
diff --git a/docs/en/collector/event-dispatcher.md → docs/guide/en/collector/event-dispatcher.md b/docs/en/collector/event-dispatcher.md → docs/guide/en/collector/event-dispatcher.md
diff --git a/docs/en/collector/exception.md → docs/guide/en/collector/exception.md b/docs/en/collector/exception.md → docs/guide/en/collector/exception.md
diff --git a/docs/en/collector/http-client.md → docs/guide/en/collector/http-client.md b/docs/en/collector/http-client.md → docs/guide/en/collector/http-client.md
diff --git a/docs/en/collector/logger.md → docs/guide/en/collector/logger.md b/docs/en/collector/logger.md → docs/guide/en/collector/logger.md
diff --git a/docs/en/collector/service.md → docs/guide/en/collector/service.md b/docs/en/collector/service.md → docs/guide/en/collector/service.md
diff --git a/docs/en/collector/summary.md → docs/guide/en/collector/summary.md b/docs/en/collector/summary.md → docs/guide/en/collector/summary.md
diff --git a/docs/en/collector/var-dumper.md → docs/guide/en/collector/var-dumper.md b/docs/en/collector/var-dumper.md → docs/guide/en/collector/var-dumper.md
diff --git a/docs/en/collector/web/middleware.md → docs/guide/en/collector/web/middleware.md b/docs/en/collector/web/middleware.md → docs/guide/en/collector/web/middleware.md
diff --git a/docs/en/collector/web/request.md → docs/guide/en/collector/web/request.md b/docs/en/collector/web/request.md → docs/guide/en/collector/web/request.md
diff --git a/docs/en/collector/web/web-app-info.md → docs/guide/en/collector/web/web-app-info.md b/docs/en/collector/web/web-app-info.md → docs/guide/en/collector/web/web-app-info.md
diff --git a/docs/en/command-container.md → docs/guide/en/command-container.md b/docs/en/command-container.md → docs/guide/en/command-container.md
@@ -4,7 +4,7 @@ The `debug/container` command displays all registered services and config groups
 
 For example:
 
-```
+```text
 ❯ ./yii debug:container
 +---------------------- params-console -----------------------+
 | Group                        | Services                     |

diff --git a/docs/en/command-events.md → docs/guide/en/command-events.md b/docs/en/command-events.md → docs/guide/en/command-events.md
@@ -29,6 +29,7 @@ For example:
 | Yiisoft\Yii\Cycle\Event\AfterMigrate                  | 1     | Yiisoft\Yii\Cycle\Listener\MigrationListener::onAfterMigrate         |
 +-------------------------------------------------------+-------+----------------------------------------------------------------------+
 ```
+
 ### List all groups
 
 You can list all groups by specifying `--groups` option:

diff --git a/docs/en/command-reset.md → docs/guide/en/command-reset.md b/docs/en/command-reset.md → docs/guide/en/command-reset.md
diff --git a/docs/en/filtering.md → docs/guide/en/filtering.md b/docs/en/filtering.md → docs/guide/en/filtering.md
diff --git a/docs/en/logging.md → docs/guide/en/logging.md b/docs/en/logging.md → docs/guide/en/logging.md
diff --git a/docs/guide/pt-BR/README.md b/docs/guide/pt-BR/README.md
@@ -0,0 +1,34 @@
+# Documentation
+
+## Configuration
+
+- [Filtering requests and console commands](filtering.md)
+- [Logging storage](logging.md)
+
+## Collectors
+
+- [Main concept](collector.md)
+- [Summary collectors](collector/summary.md)
+- [Service Collector](collector/service.md)
+- [VarDumper Collector](collector/var-dumper.md)
+- [Log Collector](collector/logger.md)
+- [Event Collector](collector/event-dispatcher.md)
+- [HttpClient Collector](collector/http-client.md)
+- [Exception Collector](collector/exception.md)
+
+### Web collectors
+
+- [Middleware Collector](collector/web/middleware.md)
+- [Request Collector](collector/web/request.md)
+- [WebAppInfo Collector](collector/web/web-app-info.md)
+
+### Console collectors
+
+- [Command Collector](collector/console/command.md)
+- [ConsoleAppInfo Collector](collector/console/console-app-info.md)
+
+## Console commands
+
+- [`debug:reset`](command-reset.md)
+- [`debug:container`](command-container.md)
+- [`debug:events`](command-events.md)