Fix docs

README.md

@@ -5,8 +5,15 @@
     <h1 align="center">Yii Database</h1>
 </p>
 
+[![Latest Stable Version](https://poser.pugx.org/yiisoft/db/v/stable.png)](https://packagist.org/packages/yiisoft/db)
+[![Total Downloads](https://poser.pugx.org/yiisoft/db/downloads.png)](https://packagist.org/packages/yiisoft/db)
+[![Build status](https://github.com/yiisoft/db/workflows/build/badge.svg)](https://github.com/yiisoft/db/actions?query=workflow%3Abuild)
+[![codecov](https://codecov.io/gh/yiisoft/db/branch/master/graph/badge.svg?token=pRr4gci2qj)](https://codecov.io/gh/yiisoft/db)
+[![static analysis](https://github.com/yiisoft/db/actions/workflows/static.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db/actions/workflows/static.yml)
+[![type-coverage](https://shepherd.dev/github/yiisoft/db/coverage.svg)](https://shepherd.dev/github/yiisoft/db)
+
 Yii Database is a framework-agnostic package to work with different types of databases,
-such as [MariaDB], [MSSQL], [MySQL], [Oracle], [PostgreSQL], and [SQLite].
+such as [MariaDB], [MSSQL], [MySQL], [Oracle], [PostgreSQL] and [SQLite].
 
 Using the package, you can perform common database tasks such as creating, reading, updating, and deleting
 records in a database table, as well as executing raw SQL queries.
@@ -35,13 +42,6 @@ similar to the way you would use ORM (Object-Relational Mapping) frameworks like
 [PostgreSQL]: https://www.postgresql.org
 [SQLite]: https://www.sqlite.org
 
-[![Latest Stable Version](https://poser.pugx.org/yiisoft/db/v/stable.png)](https://packagist.org/packages/yiisoft/db)
-[![Total Downloads](https://poser.pugx.org/yiisoft/db/downloads.png)](https://packagist.org/packages/yiisoft/db)
-[![Build status](https://github.com/yiisoft/db/workflows/build/badge.svg)](https://github.com/yiisoft/db/actions?query=workflow%3Abuild)
-[![codecov](https://codecov.io/gh/yiisoft/db/branch/master/graph/badge.svg?token=pRr4gci2qj)](https://codecov.io/gh/yiisoft/db)
-[![static analysis](https://github.com/yiisoft/db/actions/workflows/static.yml/badge.svg?branch=dev)](https://github.com/yiisoft/db/actions/workflows/static.yml)
-[![type-coverage](https://shepherd.dev/github/yiisoft/db/coverage.svg)](https://shepherd.dev/github/yiisoft/db)
-
 ## Requirements
 
 - PHP 8.0 or higher.

UPGRADE.md

@@ -1,7 +1,11 @@
-# Upgrading Instructions for Yii Database
-
-The following upgrading instructions are cumulative. That is, if you want to upgrade from version A to version C and 
-there is version B between A and C, you need to following the instructions for both A and B.
+# Yii Database Upgrading Instructions
+
+> **!!!IMPORTANT!!!**
+>
+> The following upgrading instructions are *cumulative*. That is,
+> if you want to upgrade from version A to version C and there is
+> version B between A and C, you need to following the instructions
+> for both A and B.
 
 ## Upgrade from 1.x to 2.x
 

docs/guide/en/README.md

@@ -23,13 +23,9 @@ Yii DB supports the following databases out of the box:
 - [PostgreSQL](https://www.postgresql.org/) of versions **9.6 - 15**.
 - [SQLite](https://www.sqlite.org/) of version **3.3 and above**.
 
-## Requirements
-
-- PHP 8.0 or higher.
-
 ## Installation
 
-To install Yii DB, you must select the driver you want to use and install it with [Composer](https://getcomposer.org/).
+To install Yii DB, you must select the driver you want to use and install it with [Composer](https://getcomposer.org).
 
 For [MSSQL](https://github.com/yiisoft/db-mssql):
 
@@ -61,8 +57,6 @@ For [SQLite](https://github.com/yiisoft/db-sqlite):
 composer require yiisoft/db-sqlite
 ```
 
-## Prerequisites
-
 ## Configure schema cache
 
 First, you need to [configure database schema cache](schema/cache.md).

docs/guide/pt-BR/README.md

@@ -23,13 +23,9 @@ Yii DB suporta os seguintes bancos de dados prontos para uso:
 - [PostgreSQL](https://www.postgresql.org/) das versões **9.6 - 15**.
 - [SQLite](https://www.sqlite.org/) da versão **3.3 e superior**.
 
-## Requerimentos
+## Installation
 
-- PHP 8.0 or higher.
-
-## Instalação
-
-Para instalar o Yii DB, você deve selecionar o driver que deseja usar e instalá-lo com o [Composer](https://getcomposer.org/).
+Para instalar o Yii DB, você deve selecionar o driver que deseja usar e instalá-lo com o [Composer](https://getcomposer.org).
 
 Para [MSSQL](https://github.com/yiisoft/db-mssql):
 
@@ -61,8 +57,6 @@ Para [SQLite](https://github.com/yiisoft/db-sqlite):
 composer require yiisoft/db-sqlite
 ```
 
-## Pré-requisitos
-
 ## Configurar cache de esquema
 
 Primeiro, você precisa [configurar o cache do esquema do banco de dados](schema/cache.md).

docs/internals.md

@@ -1,6 +1,68 @@
 # Internals
 
-- [Testing](./testing.md)
+## Unit testing
+
+This package can be tested globally or individually for each DBMS.
+
+- [MSSQL](https://github.com/yiisoft/db-mssql)
+- [MySQL/MariaDB](https://github.com/yiisoft/db-mysql)
+- [Oracle](https://github.com/yiisoft/db-oracle)
+- [PostgreSQL](https://github.com/yiisoft/db-pgsql)
+- [SQLite](https://github.com/yiisoft/db-sqlite)
+
+### Github actions
+
+All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db/blob/master/.github/CONTRIBUTING.md) in the cloud.
+
+> Note: We recommend pull requesting in draft mode until all tests pass.
+
+### Docker images
+
+For greater ease it is recommended to use Docker containers for each DBMS, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that in the root directory of each package.
+
+- [MSSQL 2022](https://github.com/yiisoft/db-mssql/blob/master/docker-compose.yml)
+- [MySQL 8](https://github.com/yiisoft/db-mysql/blob/master/docker-compose.yml)
+- [MariaDB 10.11](https://github.com/yiisoft/db-mysql/blob/master/docker-compose-mariadb.yml)
+- [Oracle 21](https://github.com/yiisoft/db-oracle/blob/master/docker-compose.yml)
+- [PostgreSQL 15](https://github.com/yiisoft/db-pgsql/blob/master/docker-compose.yml)
+
+For running the Docker containers you can use the following command:
+
+```shell
+docker compose up -d
+```
+
+### Global testing
+
+The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+
+1. Run all Docker containers for each DBMS.
+2. Install the dependencies of the project with composer.
+3. Run the tests.
+
+```shell
+./vendor/bin/phpunit
+```
+
+### Individual testing
+
+The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+
+1. Run the Docker container for the dbms you want to test.
+2. Install the dependencies of the project with composer.
+3. Run the tests.
+
+```shell
+./vendor/bin/phpunit --testsuite=Pgsql
+```
+
+Suites available:
+
+- Mssql
+- Mysql
+- Oracle
+- Pgsql
+- Sqlite
 
 ## Static analysis