docs: Standardize headings and improve clarity in documentation files. (#52)

Author: terabytesoftw

CHANGELOG.md

@@ -19,6 +19,7 @@
 - Bug #49: Update documentation for `ServiceMap` and related classes to enhance clarity for Yii Application static analysis (@terabytesoftw)
 - 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)
 
 ## 0.2.3 June 09, 2025
 

README.md

@@ -1,11 +1,11 @@
-<p align="center">
+<p style="text-align: center;">
     <a href="https://github.com/yii2-extensions/phpstan" target="_blank">
-        <img src="https://www.yiiframework.com/image/yii_logo_light.svg" height="100px;">
+        <img src="https://www.yiiframework.com/image/yii_logo_light.svg" height="100px;" alt="Yii Framework">
     </a>
-    <h1 align="center">Extension for PHPStan</h1>
+    <h1 style="text-align: center;">Extension for PHPStan</h1>
 </p>
 
-<p align="center">
+<p style="text-align: center;">
     <a href="https://www.php.net/releases/8.1/en.php" target="_blank">
         <img src="https://img.shields.io/badge/PHP-%3E%3D8.1-787CB5" alt="PHP-Version">
     </a>
@@ -63,7 +63,7 @@ inference, dynamic method resolution, and comprehensive property reflection.
 composer require --dev yii2-extensions/phpstan
 ```
 
-## Quick Start
+## Quick start
 
 Create a `phpstan.neon` file in your project root.
 
@@ -110,34 +110,34 @@ Run `PHPStan`.
 vendor/bin/phpstan analyse
 ```
 
-## Type Inference Examples
+## Type inference examples
 
-### ActiveRecord
+### Active Record
 
 ```php
-// ✅ Properly typed as User|null
+// ✅ Typed as User|null
 $user = User::findOne(1);
 
-// ✅ Properly typed as User[]
+// ✅ Typed as User[]
 $users = User::findAll(['status' => 'active']);
 
 // ✅ Generic ActiveQuery<User> with method chaining
 $query = User::find()->where(['active' => 1])->orderBy('name');
 
-// ✅ Array results properly typed as array{id: int, name: string}[]
+// ✅ Array results typed as array{id: int, name: string}[]
 $userData = User::find()->asArray()->all();
 
-// ✅ Properly typed based on model property annotations string
+// ✅ Typed based on model property annotations string
 $userName = $user->getAttribute('name');
 
 // ✅ Behavior property resolution string
 $slug = $user->getAttribute('slug');
 ```
 
-### Application Components
+### Application components
 
 ```php
-// ✅ Properly typed based on your configuration
+// ✅ Typed based on your configuration
 $mailer = Yii::$app->mailer; // MailerInterface
 $db = Yii::$app->db;         // Connection
 $user = Yii::$app->user;     // User
@@ -149,7 +149,7 @@ if (Yii::$app->user->isGuest === false) {
 }
 ```
 
-### Dependency Injection
+### Dependency injection
 
 ```php
 $container = new Container();

docs/configuration.md

@@ -1,12 +1,12 @@
-# Configuration Reference
+# Configuration reference
 
 ## Overview
 
 This guide covers all configuration options for the Yii2 PHPStan extension, from basic setup to advanced scenarios.
 
-## Basic Configuration
+## Basic configuration
 
-### Minimal Setup
+### Minimal setup
 
 ```neon
 includes:
@@ -24,7 +24,7 @@ parameters:
         config_path: config/phpstan-config.php
 ```
 
-### Standard Web Application
+### Standard web application
 
 ```neon
 includes:
@@ -54,9 +54,9 @@ parameters:
         config_path: config/phpstan-config.php
 ```
 
-## Application Type Configuration
+## Application type configuration
 
-### Web Application (Default)
+### Web application (default)
 
 ```php
 <?php
@@ -69,7 +69,7 @@ return [
 ];
 ```
 
-### Console Application
+### Console application
 
 For console applications, you **must** explicitly specify the application type.
 
@@ -107,9 +107,9 @@ parameters:
         config_path: config/phpstan-console-config.php
 ```
 
-## Dynamic Constants Configuration
+## Dynamic constants configuration
 
-### Default Constants
+### Default constants
 
 The extension automatically recognizes these Yii2 constants:
 
@@ -123,7 +123,7 @@ parameters:
         - YII_ENV_TEST
 ```
 
-### Adding Custom Constants
+### Adding custom constants
 
 ⚠️ **Important**: When you define `dynamicConstantNames`, it **replaces** the defaults. Include Yii2 constants explicitly.
 
@@ -142,9 +142,9 @@ parameters:
         - FEATURE_FLAGS
 ```
 
-## Service Map Configuration
+## Service map configuration
 
-### Component Configuration
+### Component configuration
 
 Define your application components for proper type inference:
 
@@ -197,7 +197,7 @@ return [
 ];
 ```
 
-### Behavior Configuration
+### Behavior configuration
 
 Configure behaviors for proper method and property reflection.
 
@@ -217,7 +217,7 @@ return [
 ];
 ```
 
-### Behavior PHPDoc Requirements
+### Behavior PHPDoc requirements
 
 For accurate type inference, behaviors should define their properties using PHPDoc.
 
@@ -239,7 +239,7 @@ use yii\db\ActiveRecord;
 class NestedSetsBehavior extends Behavior {}
 ```
 
-### Container Configuration
+### Container configuration
 
 Define DI container services.
 
@@ -276,9 +276,9 @@ return [
 ];
 ```
 
-## Advanced Configuration
+## Advanced configuration
 
-### Strict Analysis Setup
+### Strict analysis setup
 
 ```neon
 includes:
@@ -322,7 +322,7 @@ parameters:
         - '#Access to an undefined property.*#'
 ```
 
-### Performance Optimization
+### Performance optimization
 
 ```neon
 parameters:   
@@ -350,15 +350,15 @@ declare(strict_types=1);
 
 error_reporting(-1);
 
-// Define constants without full application bootstrap
+// Define constants without a full application bootstrap
 defined('YII_DEBUG') or define('YII_DEBUG', true);
 defined('YII_ENV') or define('YII_ENV', 'test');
 
 // Load only essential classes
 require(dirname(__DIR__) . '/vendor/yiisoft/yii2/Yii.php');
 ```
 
-## Configuration Without Config File
+## Configuration without a config file
 
 If you don't want to create a separate configuration file:
 
@@ -370,18 +370,18 @@ parameters:
 
 This will work with basic type inference but won't have custom component types.
 
-## Multiple Application Types
+## Multiple application types
 
 For projects with both web and console applications:
 
-### Project Structure
+### Project structure
 ```text
 phpstan-web.neon      # Web-specific configuration
 phpstan-console.neon  # Console-specific configuration
 phpstan.neon          # Base configuration
 ```
 
-### Base Configuration
+### Base configuration
 ```neon
 # phpstan.neon
 includes:
@@ -393,7 +393,7 @@ parameters:
     tmpDir: %currentWorkingDirectory%/tests/runtime
 ```
 
-### Web Configuration
+### Web configuration
 ```neon
 # phpstan-web.neon
 includes:
@@ -410,7 +410,7 @@ parameters:
         config_path: config/phpstan-config.php
 ```
 
-### Console Configuration
+### Console configuration
 ```neon
 # phpstan-console.neon
 includes:
@@ -434,7 +434,7 @@ vendor/bin/phpstan analyse -c phpstan-web.neon
 vendor/bin/phpstan analyse -c phpstan-console.neon
 ```
 
-### File-Level Suppression
+### File-Level suppression
 
 ```php
 <?php
@@ -461,6 +461,6 @@ vendor/bin/phpstan analyse -v
 vendor/bin/phpstan analyse --generate-baseline
 ```
 
-## Next Steps
+## Next steps
 
 - 💡 [Usage Examples](examples.md)