update docs

Author: HosseinNejatiJavaremi

docs/api_reference/configs.md

@@ -5,99 +5,57 @@
 The configs module provides tools for standardized configuration management and injection, supporting consistent setup
 across services like databases, Redis, and email.
 
-## Installation
-
-This module is included in the base ArchiPy installation:
-
-```bash
-# Add ArchiPy to your project
-poetry add archipy
-```
-
-## Source Code
-
-📁 Location: `archipy/configs/`
-
-🔗 [Browse Source](https://github.com/SyntaxArc/ArchiPy/tree/master/archipy/configs)
-
-## API Stability
-
-| Component         | Status    | Notes            |
-|-------------------|-----------|------------------|
-| BaseConfig        | 🟢 Stable | Production-ready |
-| Config Templates  | 🟢 Stable | Production-ready |
-| Environment Types | 🟢 Stable | Production-ready |
-
-## Examples
-
-For practical examples, see the [Configuration Management Guide](../examples/config_management.md).
-
-## Configuration Classes
-
-### Base Config
-
-Documentation for `archipy.configs.base_config` module.
+## Quick Start
 
 ```python
 from archipy.configs.base_config import BaseConfig
 
 class AppConfig(BaseConfig):
     APP_NAME: str = "MyService"
     DEBUG: bool = False
-
-    # Database settings
     DB_HOST: str = "localhost"
     DB_PORT: int = 5432
 ```
 
-*Includes all members, undocumented members, and shows inheritance.*
-
-### Config Templates
-
-Documentation for `archipy.configs.config_template` module.
-
-```python
-from archipy.configs.config_template import SQLAlchemyConfig
-
-class DatabaseConfig(SQLAlchemyConfig):
-    DB_POOL_SIZE: int = 5
-    DB_POOL_TIMEOUT: int = 30
-```
+## API Stability
 
-*Includes all members, undocumented members, and shows inheritance.*
+| Component         | Status    | Notes            |
+|-------------------|-----------|------------------|
+| BaseConfig        | 🟢 Stable | Production-ready |
+| Config Templates  | 🟢 Stable | Production-ready |
+| Environment Types | 🟢 Stable | Production-ready |
 
-## Key Classes
+## Core Classes
 
 ### BaseConfig
 
-Class: `archipy.configs.base_config.BaseConfig`
-
-Configures:
+The main configuration class that provides environment variable support, type validation, and global configuration access.
 
+**Key Features:**
 - Environment variable support
 - Type validation
 - Global configuration access
 - Nested configuration support
 
-*Includes all members, undocumented members, and shows inheritance.*
-
 ### SQLAlchemyConfig
 
-Class: `archipy.configs.config_template.SQLAlchemyConfig`
-
-Configures:
+Database configuration template with connection settings, pool configuration, and debug options.
 
+**Key Features:**
 - Database connection settings
 - Pool configuration
 - Migration settings
 - Debug options
 
-Attributes:
+## Examples
 
-- `DATABASE`: Database name
-- `DRIVER_NAME`: Database driver name
-- `ECHO`: Whether to log SQL statements
-- `ECHO_POOL`: Whether to log connection pool events
+For practical examples, see the [Configuration Management Guide](../examples/config_management.md).
+
+## Source Code
+
+📁 Location: `archipy/configs/`
+
+🔗 [Browse Source](https://github.com/SyntaxArc/ArchiPy/tree/master/archipy/configs)
 - `ENABLE_FROM_LINTING`: Whether to enable SQL linting
 - `HIDE_PARAMETERS`: Whether to hide SQL parameters in logs
 - `HOST`: Database host

docs/api_reference/models.md

@@ -3,101 +3,71 @@
 The `models` module provides core data structures and types used throughout the application, following clean
 architecture principles.
 
-## DTOs (Data Transfer Objects)
-
-### Base DTOs
-
-Base classes for all DTOs with common functionality.
+## Quick Start
 
 ```python
 from archipy.models.dtos.base_dtos import BaseDTO
-from pydantic import BaseModel
+from archipy.models.entities.sqlalchemy.base_entities import BaseEntity
 
+# Create a DTO
 class UserDTO(BaseDTO):
     id: str
     username: str
     email: str
-    created_at: datetime
-```
-
-::: archipy.models.dtos.base_dtos
-options:
-show_root_heading: true
-show_source: true
-
-### Protobuf DTOs
 
-Base class for DTOs that can be converted to and from Google Protocol Buffer messages.
-
-```python
-from archipy.models.dtos.base_protobuf_dto import BaseProtobufDTO
-from google.protobuf.message import Message
-
-class UserProtobufDTO(BaseProtobufDTO):
-    _proto_class = UserProto  # Your protobuf message class
-
-    id: str
+# Create an entity
+class User(BaseEntity):
+    __tablename__ = "users"
     username: str
     email: str
-
-# Convert from protobuf to DTO
-user_dto = UserProtobufDTO.from_proto(protobuf_message)
-
-# Convert DTO to protobuf
-protobuf_message = user_dto.to_proto()
 ```
 
-::: archipy.models.dtos.base_protobuf_dto
-options:
-show_root_heading: true
-show_source: true
-
-### Email DTOs
-
-DTOs for email-related operations.
-
-```python
-from archipy.models.dtos.email_dtos import EmailAttachmentDTO
+## Core Components
 
-attachment = EmailAttachmentDTO(
-    filename="document.pdf",
-    content_type="application/pdf",
-    content=b"..."
-)
-```
-
-::: archipy.models.dtos.email_dtos
-options:
-show_root_heading: true
-show_source: true
+### DTOs (Data Transfer Objects)
 
-### Error DTOs
+**Base DTOs** - Base classes for all DTOs with common functionality
+**Protobuf DTOs** - DTOs that can be converted to/from Google Protocol Buffer messages
+**Email DTOs** - DTOs for email-related operations
+**Error DTOs** - Standardized error response format
+**Pagination DTO** - Handles pagination parameters for queries
+**Range DTOs** - Handles range-based queries (integer, date, datetime)
+**Search Input DTO** - Standardized search input format
+**Sort DTO** - Handles sorting parameters
 
-Standardized error response format.
+### Entities
 
-```python
-from archipy.models.dtos.error_dto import ErrorDetailDTO
+**Base Entities** - Base classes for SQLAlchemy entities with common functionality
+**Update Tracking** - Entities with automatic update timestamp tracking
+**Soft Deletion** - Entities with soft deletion support
+**Admin Tracking** - Entities with admin user tracking
+**Manager Tracking** - Entities with manager user tracking
 
-error = ErrorDetailDTO(
-    code="USER_NOT_FOUND",
-    message_en="User not found",
-)
-```
+### Errors
 
-::: archipy.models.dtos.error_dto
-options:
-show_root_heading: true
-show_source: true
+**Base Error** - Base class for all custom exceptions
+**Auth Errors** - Authentication and authorization errors
+**Business Errors** - Business logic violation errors
+**Database Errors** - Database operation errors
+**Network Errors** - Network communication errors
+**Resource Errors** - Resource not found or access errors
+**System Errors** - System-level errors
+**Validation Errors** - Data validation errors
 
-### Pagination DTO
+### Types
 
-Handles pagination parameters for queries.
+**Base Types** - Common type definitions
+**Email Types** - Email-related type definitions
+**Error Message Types** - Error message type definitions
+**Language Type** - Language enumeration
+**Sort Order Type** - Sort order enumeration
+**Time Interval Unit Type** - Time interval unit enumeration
 
-```python
-from archipy.models.dtos.pagination_dto import PaginationDTO
+## Examples
 
-pagination = PaginationDTO(
-    page=1,
+For detailed examples, see:
+- [Protobuf DTOs](../examples/models/protobuf_dtos.md)
+- [Error Handling](../examples/error_handling.md)
     page_size=10,
     total_items=100
 )

mkdocs.yml

@@ -121,6 +121,7 @@ nav:
       - Keycloak: examples/adapters/keycloak.md
       - MinIO: examples/adapters/minio.md
       - Kafka: examples/adapters/kafka.md
+      - Payment Gateways: examples/adapters/parsian_payment.md
     - Helpers:
       - Overview: examples/helpers/index.md
       - Decorators: examples/helpers/decorators.md
@@ -129,6 +130,9 @@ nav:
       - Utils: examples/helpers/utils.md
     - Configuration: examples/config_management.md
     - Testing: examples/bdd_testing.md
+    - Error Handling: examples/error_handling.md
+    - Models:
+      - Protobuf DTOs: examples/models/protobuf_dtos.md
   - Changelog: changelog.md
   - Contributing: contributing.md
   - Architecture: architecture.md