Fix docs (#23)

* Fix docs

* Update README.md

* Fix docs

---------

Co-authored-by: Alexey Rogachev <[email protected]>

Author: luizcmarin

README.md

@@ -1,6 +1,6 @@
 <p align="center">
     <a href="https://github.com/yiisoft" target="_blank">
-        <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px">
+        <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
     </a>
     <h1 align="center">Yii Data Cycle</h1>
     <br>
@@ -32,7 +32,7 @@ composer require yiisoft/data-cycle
 
 ## Documentation
 
-- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md), [Русский](docs/guide/ru/README.md), [Spanish](docs/guide/es/README.md)
+- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md), [Spanish](docs/guide/es/README.md), [Русский](docs/guide/ru/README.md)
 - [Internals](docs/internals.md)
 
 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

composer.json

@@ -13,11 +13,11 @@
     "license": "BSD-3-Clause",
     "support": {
         "issues": "https://github.com/yiisoft/data-cycle/issues?state=open",
+        "source": "https://github.com/yiisoft/data-cycle",
         "forum": "https://www.yiiframework.com/forum/",
         "wiki": "https://www.yiiframework.com/wiki/",
         "irc": "ircs://irc.libera.chat:6697/yii",
-        "chat": "https://t.me/yii3en",
-        "source": "https://github.com/yiisoft/data-cycle"
+        "chat": "https://t.me/yii3en"
     },
     "funding": [
         {
@@ -55,7 +55,9 @@
         "psr-4": {
             "Yiisoft\\Data\\Cycle\\Tests\\": "tests"
         },
-        "files": ["tests/bootstrap.php"]
+        "files": [
+            "tests/bootstrap.php"
+        ]
     },
     "config": {
         "sort-packages": true,

docs/guide/en/entity-reader.md

@@ -1,24 +1,24 @@
-# EntityReader
+# EntityReader Class
 
 `EntityReader` allows to securely pass select-queries from repository to user runtime.
 By select-query we assume an instance of `\Cycle\ORM\Select` or `\Cycle\Database\Query\SelectQuery`.
 
 You need to know the following about `EntityReader`:
 
-* `EntityReader` implements `IteratorAggregate`.
+- `EntityReader` implements `IteratorAggregate`.
  It allows using `EntityReader` instance in `foreach`.
-* Using `EntityReader` you can adjust select-query:
+- Using `EntityReader` you can adjust select-query:
   - Add `Limit` and `Offset` manually or using `OffsetPaginator`
   - Specify sorting. Note that `EntityReader` sorting does
     not replace initial query sorting but adds sorting on top of it.
     Each next `withSort()` call is replacing `EntityReader` sorting options.
   - Apply filter. Filtration conditions in `EntityReader` also, do not replace filtration conditions
     in initial query, but adds conditions on top of it. Therefore, by using filtration in `SeletecDataReader`
     you can only refine the selection, but NOT expand.
-* `EntityReader` queries database only when you actually read the data.
-* In case you're using `read()`, `readOne()` or `count()`, data will be cached by `EntityReader`.
-* The `count()` method returns the number of elements without taking limit and offset into account.
-* In case you want to avoid caching, use `getIterator()`. Note that if cache is already there, `getIterator()`
+- `EntityReader` queries database only when you actually read the data.
+- In case you're using `read()`, `readOne()` or `count()`, data will be cached by `EntityReader`.
+- The `count()` method returns the number of elements without taking limit and offset into account.
+- In case you want to avoid caching, use `getIterator()`. Note that if cache is already there, `getIterator()`
   uses it.
 
 ## Examples
@@ -152,6 +152,7 @@ function index(ArticleRepository $repository)
         ->withSort(Sort::any()->withOrder(['published_at' => 'asc']));
 }
 ```
+
 You may refine query conditions with filters. This filtering conditions are adding to original select query conditions, but NOT replace them.
 
 ```php

docs/guide/es/entity-reader.md

@@ -1,20 +1,20 @@
-# EntityReader
+# Clase EntityReader
 
 `EntityReader` es una herramienta útil para transferir de forma segura las solicitudes de selección del repositorio en tiempo de ejecución del usuario.
 
 Una solicitud de selección se refiere a una instancia de una de las clases: ``CycleORM\Select`` o ``Spiral\Database\Query\SelectQuery``.
 
 Lo que hay que saber sobre `EntityReader`:
 
-* La clase `EntityReader` implementa la interfaz `IteratorAggregate`. Esto permite utilizar el objeto `EntityReader` en un bucle `foreach`.
-* Con `EntityReader` se puede ajustar la consulta de selección:
+- La clase `EntityReader` implementa la interfaz `IteratorAggregate`. Esto permite utilizar el objeto `EntityReader` en un bucle `foreach`.
+- Con `EntityReader` se puede ajustar la consulta de selección:
   - Establezca `Limit` y `Offset` manualmente con `OffsetPaginator`.
   - La ordenación por `EntityReader` no sustituye la ordenación en la consulta original, sólo la complementa. Sin embargo, cada llamada posterior al método `withSort()` sustituirá la configuración de clasificación del objeto `EntityReader`.
   - Las condiciones del filtro `EntityReader` tampoco sustituyen al de filtrado en la consulta original, solo la complementan. Así, que al filtrar el objeto `EntityReader`, sólo puede ajustar la selección pero no ampliarla.
-* `EntityReader` no extrae los datos de la base de datos de una sola vez. Sólo accede a la base de datos cuando se consultan esos datos.
-* Si utiliza los métodos `read()` y `readOne()` para leer los datos, entonces `EntityReader` lo almacenará en una caché. El resultado de una llamada a `count()` también se almacena en caché.
-* El método `count()` devuelve el número de todos los elementos de la muestra sin tener en cuenta las restricciones `Limit` y `Offset`.
-* Si no quieres que los datos se almacenen en caché, utiliza el método `getIterator()`. Sin embargo, si la caché ya está llena, `getIterator()` devolverá el contenido de la caché.
+- `EntityReader` no extrae los datos de la base de datos de una sola vez. Sólo accede a la base de datos cuando se consultan esos datos.
+- Si utiliza los métodos `read()` y `readOne()` para leer los datos, entonces `EntityReader` lo almacenará en una caché. El resultado de una llamada a `count()` también se almacena en caché.
+- El método `count()` devuelve el número de todos los elementos de la muestra sin tener en cuenta las restricciones `Limit` y `Offset`.
+- Si no quieres que los datos se almacenen en caché, utiliza el método `getIterator()`. Sin embargo, si la caché ya está llena, `getIterator()` devolverá el contenido de la caché.
 
 ## Ejemplos
 

docs/guide/pt-BR/entity-reader.md

@@ -1,30 +1,30 @@
-# EntityReader
+# Classe EntityReader
 
 `EntityReader` permite passar com segurança consultas de seleção do repositório para o tempo de execução do usuário.
 Por consulta selecionada, assumimos uma instância de `\Cycle\ORM\Select` ou `\Cycle\Database\Query\SelectQuery`.
 
 Você precisa saber o seguinte sobre `EntityReader`:
 
-* `EntityReader` implementa `IteratorAggregate`.
+- `EntityReader` implementa `IteratorAggregate`.
   Ele permite usar a instância `EntityReader` em `foreach`.
-* Usando `EntityReader` você pode ajustar a consulta de seleção:
-  * Adicione manualmente `Limit` e `Offset` ou usando `OffsetPaginator`
-  * Especifique a classificação. Observe que a classificação `EntityReader`
-     não substitui a classificação da consulta inicial, mas adiciona uma classificação np topo dela.
+- Usando `EntityReader` você pode ajustar a consulta de seleção:
+  - Adicione manualmente `Limit` e `Offset` ou usando `OffsetPaginator`
+  - Especifique a classificação. Observe que a classificação `EntityReader`
+     não substitui a classificação da consulta inicial, mas adiciona uma classificação no topo dela.
      Cada próxima chamada `withSort()` substitui as opções de classificação `EntityReader`.
-  * Aplicar filtro. As condições de filtragem em `EntityReader` também não substituem as condições de filtragem
+  - Aplicar filtro. As condições de filtragem em `EntityReader` também não substituem as condições de filtragem
      na consulta inicial, mas adiciona condições a ela. Portanto, usando filtragem no `SeletecDataReader`
      você só pode refinar a seleção, mas NÃO expandir.
-* `EntityReader` consulta o banco de dados somente quando você realmente lê os dados.
-* Caso você esteja usando `read()`, `readOne()` ou `count()`, os dados serão armazenados em cache por `EntityReader`.
-* O método `count()` retorna o número de elementos sem levar em consideração o limite e o deslocamento.
-* Caso você queira evitar o cache, use `getIterator()`. Observe que se o cache já estiver lá, `getIterator()`
+- `EntityReader` consulta o banco de dados somente quando você realmente lê os dados.
+- Caso você esteja usando `read()`, `readOne()` ou `count()`, os dados serão armazenados em cache por `EntityReader`.
+- O método `count()` retorna o número de elementos sem levar em consideração o limite e o deslocamento.
+- Caso você queira evitar o cache, use `getIterator()`. Observe que se o cache já estiver lá, `getIterator()`
    vai usá-lo.
 
 ## Exemplos
 
 Vamos implementar um repositório para trabalhar com tabela de artigos. Queremos um método para obter artigos públicos `findPublic()` mas
-não retornaria uma coleção de artigos prontos ou uma consulta selecionada. Em vez disso, retornar `EntityReader`:
+ue não retorne uma coleção de artigos prontos ou uma consulta selecionada. Em vez disso, retorne `EntityReader`:
 
 ```php
 use Yiisoft\Data\Cycle\Data\Reader\EntityReader;
@@ -152,7 +152,6 @@ function index(ArticleRepository $repository)
         ->withSort(Sort::any()->withOrder(['published_at' => 'asc']));
 }
 ```
-
 Você pode refinar as condições de consulta com filtros. Essas condições de filtragem são adicionadas às condições de consulta de seleção originais, mas NÃO as substituem.
 
 ```php
@@ -174,4 +173,4 @@ class ArticleRepository extends \Cycle\ORM\Select\Repository
 ```
 
 Use filtros do pacote [yiisoft/data](https://github.com/yiisoft/data) ou qualquer outro, tendo previamente escrito
-os manipuladores (processadores) apropriados para eles.
+os handlers(processors) apropriados para eles.

docs/guide/ru/entity-reader.md

@@ -7,9 +7,9 @@
 
 Что нужно знать о `EntityReader`:
 
-* Класс `EntityReader` реализует интерфейс `IteratorAggregate`.
+- Класс `EntityReader` реализует интерфейс `IteratorAggregate`.
   Это позволяет использовать объект `EntityReader` в цикле `foreach`.
-* С помощью `EntityReader` вы можете корректировать переданный select-запрос:
+- С помощью `EntityReader` вы можете корректировать переданный select-запрос:
   - Выставлять `Limit` и `Offset` вручную или с помощью `OffsetPaginator`.
   - Задавать сортировку. Но учтите, что сортировка `EntityReader`
     не заменяет сортировку в исходном запросе, а лишь дополняет её.
@@ -18,12 +18,12 @@
   - Применять фильтр. Условия фильтрации `EntityReader` также не заменяют настройки
     фильтрации в исходном запросе, а дополняют её. Таким образом, фильтрацией
     в объекте `EntityReader` вы можете только уточнить выборку, но не расширить.
-* `EntityReader` не вытягивает данные из БД сразу.
+- `EntityReader` не вытягивает данные из БД сразу.
   Обращение к БД происходит только тогда, когда эти данные запрашиваются.
-* Если вы будете использовать методы `read()` и `readOne()` для чтения данных,
+- Если вы будете использовать методы `read()` и `readOne()` для чтения данных,
   то `EntityReader` сохранит их в кеше. Кешируется также и результат вызова `count()`.
-* Метод `count()` возвращает кол-во всех элементов выборки без учёта ограничений `Limit` и `Offset`.
-* Если вы не хотите, чтобы данные были записаны в кеш, то используйте метод `getIterator()`.
+- Метод `count()` возвращает кол-во всех элементов выборки без учёта ограничений `Limit` и `Offset`.
+- Если вы не хотите, чтобы данные были записаны в кеш, то используйте метод `getIterator()`.
   Однако если кеш уже заполнен, то `getIterator()` вернёт содержимое кеша.
 
 ## Примеры