wip

chevere · Jan 24, 2024 · 1146a80 · 1146a80
1 parent 0ad8d8d
commit 1146a80
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 286 deletions.
diff --git a/developer/spec/exceptions.md b/developer/spec/exceptions.md
diff --git a/developer/spec/naming.php b/developer/spec/naming.php
@@ -3,5 +3,4 @@
 return [
     'interfaces.md' => 'Interfaces',
     'components.md' => 'Components',
-    'exceptions.md' => 'Exceptions',
-];
+];
diff --git a/developer/standard/coding.md b/developer/standard/coding.md
@@ -93,5 +93,4 @@ Comments in logic should be used only in the following cases:
 DocBlock content should be **short** as possible, **relevant** and **omit** the obvious.
 
 * Use markdown
-* `@throws` must be provided for all known exceptions
 * `@param` and `@return` should be avoided (prefer typed code)
diff --git a/developer/standard/quality.md b/developer/standard/quality.md
@@ -19,7 +19,6 @@ We use the following third-party CI services:
 
 * [SonarCloud](https://sonarcloud.io/)
 * [CodeFactor](https://www.codefactor.io/)
-* [Codacy](https://www.codacy.com/)
 * [Stryker Mutator](https://stryker-mutator.io/)
 
 ## Extensively tested
@@ -32,7 +31,7 @@ To ensure the quality of the tests, all Chevere software requires **mutation tes
 
 All Chevere software **must** be documented.
 
-We use [docs-deploy](https://github.com/chevere/docs-deploy), which is our own documenting system.
+We use [docs-deploy](https://github.com/chevere/docs-deploy) documenting system.
 
 ## PHPStan Level 9
 

diff --git a/introduction/README.md b/introduction/README.md
@@ -2,35 +2,27 @@
 
 ## What is Chevere?
 
-Chevere is a strict, strong-typed PHP development library. It is the stuff developers use to build *other* software as it is an small software package providing the core tooling needed to organize and run the logic of any given software application.
+Chevere is a strict, strong-typed PHP development library. It is the stuff developers use to build *other* software as it is a collection of packages providing the core tooling needed to organize and run the logic of any given software application.
 
 💡 The term *chévere* is ubiquitous in Latin America, known in every Spanish speaking country and it means **cool/awesome**.
 
 ## Core concepts
 
 ### Clean & Typed
 
-Chevere follows [Clean Code](http://cleancoder.com/products) principles, which can be resumed as the practice of creating code that is easy to understand, to change and maintain.
+Chevere follows Clean Code principles, which can be resumed as the practice of creating code that is easy to understand, to change and maintain.
 
 ### Extensible
 
-A core library tooling for general purposes, with enough flexibility to allow the creation a myriad of systems with the same know-how. Also packages for specific needs.
+Packages of all types, with enough flexibility to allow the creation a myriad of systems with the same know-how.
 
 ### Modern & High quality
 
 All-new PHP 8 codebase with strict standards. Chevere has been designed from scratch for PHP 8, and it uses all the goodies added to it. On top of that it follows own high [quality](../developer/standard/quality.md) standards.
 
-## Why Chevere and not X?
-
-If you can use software from *well-known* vendors why you should use Chevere?
-
-Main reason for Chevere is its high quality with a clean syntax. You can tell that by interacting with Chevere and because the code is scrutinized by several third-party tools.
-
-It is day and night when the arguments to use a codebase are vague subjective terms like *expressive syntax* or *well-maintained* compared to objetive code measure metrics.
-
 ## Who makes Chevere?
 
-Chevere is driven by [Chevereto](https://chevereto.com) and is made by the same author ([Rodolfo Berrios](https://rodolfoberrios.com), hi) with solid 18+ years of experience building systems.
+Chevere is driven by [Chevereto](https://chevereto.com) and is made by the same author ([Rodolfo Berrios](https://rodolfoberrios.com), hi).
 
 Chevere was created as the supporting framework for Chevereto, and Chevereto supports Chevere's development.
 

diff --git a/introduction/installation.md b/introduction/installation.md
@@ -1,33 +1,9 @@
 # Installation
 
-## System Requirements
+Chevere is a set of [PHP packages](https://packagist.org/packages/chevere/) packages that can be installed using [Composer](https://getcomposer.org/).
 
-💡 Chevere system requirements can be found in the `composer.json` file.
-
-### PHP
-
-Chevere is built and tested for [unix-like systems](../developer/environment/system.md#operating-system).
-
-* [PHP 8](https://www.php.net/releases/8.0)
-
-The [chevere.ini](https://github.com/chevere/chevere/blob/main/chevere.ini) file provides the PHP settings required for Chevere.
-
-## Installing
-
-* Requires [Composer](https://getcomposer.org/)
+If you need to use several packages consider installing [chevere/chevere](https://github.com/chevere/chevere) which contains all packages.
 
 ```sh
 composer require chevere/chevere
 ```
-
-The above command will install Chevere and its dependencies at `vendor/`.
-
-## Now what?
-
-Chevere will be available project-wide. Make sure to load `vendor/autoload.php` in your entry point:
-
-```php
-require 'vendor/autoload.php';
-```
-
-Once installed you can start using any of the built-in [components](../library/README.md).
diff --git a/library/naming.php b/library/naming.php
diff --git a/library/string.md b/library/string.md
diff --git a/library/type.md b/library/type.md
diff --git a/library/filesystem.md → packages/filesystem.md b/library/filesystem.md → packages/filesystem.md
@@ -1,8 +1,12 @@
 # Filesystem
 
-Namespace `Chevere\Filesystem`
+## Summary
 
-The Filesystem component is in charge of interact with the filesystem, offering a myriad of related functionalities.
+Filesystem related functionalities.
+
+## Installing
+
+Filesystem is available through [Packagist](https://packagist.org/packages/chevere/filesystem) and the repository source is at [chevere/filesystem](https://github.com/chevere/filesystem).
 
 ## Path
 
@@ -123,7 +127,7 @@ $boolean = $directory->exists();
 The `assertExists` method asserts if the directory exists. Throws exception when the directory doesn't exists in the filesystem.
 
 ```php
-use Chevere\Exceptions\Filesystem\DirNotExistsException;
+use Chevere\Filesystem\Exceptions\DirNotExistsException;
 
 $directory->assertExists(); // Throws DirNotExistsException
 ```

diff --git a/packages/naming.php b/packages/naming.php
@@ -19,4 +19,5 @@
     'writer.md' => 'Writer',
     'xrdebug.md' => 'xrDebug',
     'sql2p.md' => 'SQL2P',
+    'var-support.md' => 'VarSupport',
 ];
diff --git a/packages/sql2p.md b/packages/sql2p.md
@@ -4,7 +4,7 @@
 
 ## Summary
 
-SQL2P generates [Parameter(s)](https://chevere.org/library/parameter) for MySQL schemas. It represents database tables and its columns using the Parameter package.
+SQL2P generates [Parameter(s)](https://chevere.org/packages/parameter) for MySQL schemas. It represents database tables and its columns using the Parameter package.
 
 ## Installing
 

diff --git a/library/standard.md → packages/standard.md b/library/standard.md → packages/standard.md
@@ -1,8 +1,14 @@
 # Standard
 
-Namespace `Chevere\Standard`
+## Summary
 
-The Standard component provides improvements and alternatives to PHP's standard function library.
+Improvements and alternatives to PHP's standard function library.
+
+## Installing
+
+Standard is available through [Packagist](https://packagist.org/packages/chevere/standard) and the repository source is at [chevere/standard](https://github.com/chevere/standard).
+
+The Standard component .
 
 ## arrayFilterBoth