docs: Update documentation for consistency and clarity; change section titles and add strict types declaration. (#53)

Author: terabytesoftw

CHANGELOG.md

@@ -20,6 +20,7 @@
 - Bug #50: Add Testing Guide link to `installation` and `examples` documentation (@terabytesoftw)
 - Bug #51: Reorder Installation section in `README.md` for improved clarity (@terabytesoftw)
 - Bug #52: Standardize headings and improve clarity in documentation files (@terabytesoftw)
+- Bug #53: Update documentation for consistency and clarity; change section titles and add strict types declaration (@terabytesoftw)
 
 ## 0.2.3 June 09, 2025
 

README.md

@@ -57,14 +57,14 @@ inference, dynamic method resolution, and comprehensive property reflection.
 - Stub files for different application types (web, console, base).
 - Support for Yii2 constants (`YII_DEBUG`, `YII_ENV_*`).
 
-## Installation
+## Quick start
+
+### Installation
 
 ```bash
 composer require --dev yii2-extensions/phpstan
 ```
 
-## Quick start
-
 Create a `phpstan.neon` file in your project root.
 
 ```neon
@@ -89,6 +89,9 @@ Create a PHPStan-specific config file (`config/phpstan-config.php`).
 
 ```php
 <?php
+
+declare(strict_types=1);
+
 return [
     'components' => [
         'db' => [
@@ -110,9 +113,9 @@ Run `PHPStan`.
 vendor/bin/phpstan analyse
 ```
 
-## Type inference examples
+### Type inference examples
 
-### Active Record
+#### Active Record
 
 ```php
 // ✅ Typed as User|null
@@ -134,7 +137,7 @@ $userName = $user->getAttribute('name');
 $slug = $user->getAttribute('slug');
 ```
 
-### Application components
+#### Application components
 
 ```php
 // ✅ Typed based on your configuration
@@ -149,7 +152,7 @@ if (Yii::$app->user->isGuest === false) {
 }
 ```
 
-### Dependency injection
+#### Dependency injection
 
 ```php
 $container = new Container();

docs/configuration.md

@@ -60,6 +60,9 @@ parameters:
 
 ```php
 <?php
+
+declare(strict_types=1);
+
 // config/phpstan-config.php
 return [
     'phpstan' => [
@@ -75,6 +78,9 @@ For console applications, you **must** explicitly specify the application type.
 
 ```php
 <?php
+
+declare(strict_types=1);
+
 // config/phpstan-console-config.php
 return [
     'phpstan' => [
@@ -150,6 +156,9 @@ Define your application components for proper type inference:
 
 ```php
 <?php
+
+declare(strict_types=1);
+
 // config/phpstan-config.php
 return [
     'components' => [
@@ -203,6 +212,9 @@ Configure behaviors for proper method and property reflection.
 
 ```php
 <?php
+
+declare(strict_types=1);
+
 return [
     'behaviors' => [
         \app\models\User::class => [
@@ -224,6 +236,8 @@ For accurate type inference, behaviors should define their properties using PHPD
 ```php
 <?php
 
+declare(strict_types=1);
+
 use yii\base\Behavior;
 use yii\db\ActiveRecord;
 
@@ -245,6 +259,9 @@ Define DI container services.
 
 ```php
 <?php
+
+declare(strict_types=1);
+
 return [
     'container' => [
         'definitions' => [
@@ -345,9 +362,10 @@ Optimized bootstrap file.
 
 ```php
 <?php
-// config/phpstan-bootstrap.php
+
 declare(strict_types=1);
 
+// config/phpstan-bootstrap.php
 error_reporting(-1);
 
 // Define constants without a full application bootstrap
@@ -437,7 +455,6 @@ vendor/bin/phpstan analyse -c phpstan-console.neon
 ### File-Level suppression
 
 ```php
-<?php
 // In your PHP files
 /** @phpstan-ignore-next-line */
 $result = $someObject->unknownMethod();
@@ -464,3 +481,4 @@ vendor/bin/phpstan analyse --generate-baseline
 ## Next steps
 
 - 💡 [Usage Examples](examples.md)
+- 🧪 [Testing Guide](testing.md)

docs/examples.md

@@ -10,6 +10,8 @@ analysis in real-world scenarios.
 ```php
 <?php
 
+declare(strict_types=1);
+
 use app\models\User;
 use yii\db\ActiveRecord;
 
@@ -53,6 +55,8 @@ class UserService
 ```php
 <?php
 
+declare(strict_types=1);
+
 use app\models\{User, Post};
 use yii\db\ActiveQuery;
 
@@ -102,6 +106,8 @@ class PostRepository
 ```php
 <?php
 
+declare(strict_types=1);
+
 use app\models\{User, Post, Category};
 
 class UserModel extends \yii\db\ActiveRecord
@@ -161,6 +167,8 @@ class PostService
 ```php
 <?php
 
+declare(strict_types=1);
+
 use yii\db\ActiveQuery;
 
 class PostQuery extends ActiveQuery
@@ -224,9 +232,11 @@ class PostController
 ```php
 <?php
 
+declare(strict_types=1);
+
 use Yii;
-use yii\web\Controller;
 use yii\mail\MessageInterface;
+use yii\web\Controller;
 
 class SiteController extends Controller
 {
@@ -283,8 +293,10 @@ class SiteController extends Controller
 ```php
 <?php
 
-use Yii;
+declare(strict_types=1);
+
 use app\models\User;
+use Yii;
 
 class UserService
 {
@@ -338,6 +350,8 @@ class UserService
 ```php
 <?php
 
+declare(strict_types=1);
+
 // Component configuration in config/phpstan.php
 return [
     'components' => [
@@ -399,8 +413,10 @@ class PaymentController extends Controller
 ```php
 <?php
 
-use yii\di\Container;
+declare(strict_types=1);
+
 use app\services\{PaymentService, EmailService, CacheService};
+use yii\di\Container;
 
 class ServiceManager
 {
@@ -442,8 +458,10 @@ class ServiceManager
 
 ```php
 <?php
-// config/phpstan.php - Container configuration
 
+declare(strict_types=1);
+
+// config/phpstan.php - Container configuration
 return [
     'container' => [
         'definitions' => [
@@ -510,6 +528,8 @@ class ApplicationService
 ```php
 <?php
 
+declare(strict_types=1);
+
 use yii\di\Container;
 
 class ServiceFactory
@@ -557,6 +577,8 @@ class ServiceFactory
 ```php
 <?php
 
+declare(strict_types=1);
+
 use yii\behaviors\Behavior;
 use yii\db\ActiveRecord;
 
@@ -626,6 +648,8 @@ class CategoryService
 ```php
 <?php
 
+declare(strict_types=1);
+
 // Configuration in config/phpstan.php
 return [
     'behaviors' => [
@@ -721,6 +745,8 @@ class PostService
 ```php
 <?php
 
+declare(strict_types=1);
+
 use yii\web\HeaderCollection;
 
 class ApiController extends \yii\web\Controller

docs/installation.md

@@ -191,8 +191,10 @@ Create a simple test file to verify type inference is working.
 
 ```php
 <?php
-// test-phpstan.php
 
+declare(strict_types=1);
+
+// test-phpstan.php
 use yii\web\Application;
 
 // This should be typed as an Application
@@ -211,11 +213,11 @@ vendor/bin/phpstan analyse test-phpstan.php --level=5
 
 ## Bootstrap configuration
 
-If your application requires custom bootstrap logic, create a bootstrap file.
+If your application requires custom bootstrap logic, create a bootstrap file (for example, `tests/bootstrap.php`).
 
 ```php
 <?php
-// tests/bootstrap.php
+
 declare(strict_types=1);
 
 error_reporting(-1);