Skip to content

3.13.2 — 2025-09-30

← 3.13.3 | 3.13.1 → | ↑ 3.x series

Changed

Documentation Infrastructure

  • MkDocs Configuration Reorganization - Restructured MkDocs configuration for improved build performance and flexibility
    • Moved mkdocs.yml from project root to docs/ directory for better organization
    • Added docs_dir: . and site_dir: ../site configuration for proper directory mapping
    • Created docs/mkdocs-fast.yml for fast local development builds (10-20s)
    • Created docs/mkdocs-full.yml for complete production builds (2-5min)
    • Implemented configuration inheritance using INHERIT directive to reduce duplication
    • Enhanced main mkdocs.yml with performance optimizations and balanced settings

Documentation Performance

  • MkDocs Build Optimization - Significantly improved documentation build performance
    • Disabled source code display by default for faster rendering (show_source: false)
    • Simplified object paths for reduced processing time (show_object_full_path: false)
    • Disabled submodule auto-expansion for improved performance (show_submodules: false)
    • Disabled base class display to reduce content size (show_bases: false)
    • Enabled summary mode for faster documentation generation (summary: true)
    • Excluded undocumented items from generation (show_if_no_docstring: false)
    • Disabled inherited member display for major performance gain (inherited_members: false)
    • Added environment variable control for mkdocstrings (ENABLE_MKDOCSTRINGS)

Documentation Features

  • Enhanced Navigation - Improved user experience with modern Material theme features
    • Added instant prefetch for faster page navigation (navigation.instant.prefetch)
    • Added loading progress indicator (navigation.instant.progress)
    • Maintained existing features: instant loading, tracking, tabs, sections, ToC, code copy

CI/CD Pipeline

  • GitHub Actions Workflow Update - Enhanced documentation deployment workflow
    • Updated deploy workflow to use docs/mkdocs-full.yml for production builds
    • Maintained full feature set for GitHub Pages deployment
    • Improved build reliability with explicit configuration file reference

ReadTheDocs Configuration

  • Configuration Update - Updated ReadTheDocs configuration for new structure
    • Updated mkdocs.configuration path to docs/mkdocs.yml
    • Maintained compatibility with ReadTheDocs build system
    • Ensured proper documentation generation on ReadTheDocs platform

Makefile Enhancements

  • Documentation Build Commands - Added comprehensive make targets for all build modes
    • Added docs-serve for balanced mode development (default)
    • Added docs-serve-fast for quick iterations with fast builds
    • Added docs-serve-no-api for fastest builds without API generation
    • Added docs-build for balanced builds
    • Added docs-build-fast for fast configuration builds
    • Added docs-build-full for production builds with all features
    • Updated docs-deploy to use full configuration for production deployment

Documentation Content

  • Usage Guide Restructuring - Completely rewrote usage documentation for better onboarding

    • Restructured as quick-start guide focusing on 5-minute setup
    • Added minimal working FastAPI example for rapid prototyping
    • Added clear next steps directing users to Architecture Guide for production patterns
    • Reorganized content into Quick Start, Next Steps, Key Concepts, and Production-Ready Structure sections
    • Enhanced best practices section with clear, actionable guidelines
    • Improved navigation with links to detailed guides and examples
    • Emphasized domain-driven organization and API versioning
    • Added Command/Query/Response DTO pattern references
    • Streamlined content to focus on getting started quickly while pointing to comprehensive resources

  • Architecture Guide Expansion - Enhanced architecture documentation with comprehensive real-world example

    • Added complete end-to-end user management system example
    • Demonstrated domain-driven design with clear layer separation
    • Included API versioning patterns (/api/v1/, /api/v2/)
    • Showcased CQRS-inspired DTO naming conventions (InputDTO, CommandDTO, QueryDTO, ResponseDTO, OutputDTO)
    • Illustrated service, logic, and repository layer interactions
    • Provided complete working code for models, DTOs, errors, repositories, logic, and services
    • Demonstrated domain-specific adapters (UserDBAdapter, UserCacheAdapter)
    • Highlighted scalability, testability, and maintainability benefits
    • Emphasized framework-agnostic business logic design
    • Showed clear separation of concerns at each architectural layer

Performance

  • Optimized Documentation Build Times - Achieved significant performance improvements across all build modes
    • Fast mode: 10-20s builds for rapid local development iteration
    • Balanced mode: 30-60s builds for regular development work
    • Full mode: 2-5min builds with all features for production deployment
    • Reduced memory usage through content filtering and summary modes
    • Improved developer experience with faster feedback loops

Developer Experience

  • Improved Documentation Workflow - Enhanced documentation development and deployment experience
    • Clear separation of development and production configurations
    • Multiple build modes for different use cases and performance requirements
    • Better local development experience with fast rebuild times
    • Streamlined deployment process with optimized production builds
    • Consistent configuration management through inheritance