|
| 1 | +--- |
| 2 | +title: "Changelog 4.3.6" |
| 3 | +description: "Release notes for ArchiPy 4.3.6" |
| 4 | +--- |
| 5 | + |
| 6 | +# 4.3.6 — 2026-03-13 |
| 7 | + |
| 8 | +[← 4.3.5](4.3.5.md) | [↑ 4.x series](index.md) |
| 9 | + |
| 10 | +## Added |
| 11 | + |
| 12 | +### Helpers - Chore |
| 13 | + |
| 14 | +- **Documentation Cursor Rule** - Added a dedicated Cursor rule for documentation standards under `docs/**/*.md`. |
| 15 | + - Enforces Google-style docstrings, `snake_case` filenames, required page structure, and code example conventions |
| 16 | + across all documentation files |
| 17 | + |
| 18 | +## Fixed |
| 19 | + |
| 20 | +### Chore - CI |
| 21 | + |
| 22 | +- **Docs Deploy Trigger on Source Changes** - Extended the `deploy-docs.yml` workflow to also trigger on changes to |
| 23 | + `archipy/**` source files, not only `docs/**`. |
| 24 | + - Ensures the published documentation is rebuilt whenever adapter or helper code changes |
| 25 | +- **ReadTheDocs Build Configuration** - Repaired the `.readthedocs.yaml` configuration to restore a functional |
| 26 | + ReadTheDocs build. |
| 27 | + - Simplified configuration to match current ReadTheDocs requirements and removed stale options |
| 28 | + |
| 29 | +## Changed |
| 30 | + |
| 31 | +### Adapters - SQLAlchemy |
| 32 | + |
| 33 | +- **Filter Value Type Union Expansion** - Broadened the `value` parameter type union in |
| 34 | + `SQLAlchemyFilterMixin._apply_filter` and `_validate_list_operation`. |
| 35 | + - Added `int`, `Decimal`, `datetime`, `date`, and `Enum` to the accepted type union alongside the existing |
| 36 | + `str | float | bool | list | UUID | None` |
| 37 | + - Allows filtering on numeric, temporal, and enum-typed columns without requiring a cast at the call site |
| 38 | + |
| 39 | +## Chore |
| 40 | + |
| 41 | +### Docs - Documentation Overhaul |
| 42 | + |
| 43 | +- **API Reference Restructure** - Split the monolithic `api_reference.md` into per-module subdirectories (`adapters/`, |
| 44 | + `helpers/`) with individual pages for each adapter and helper module. |
| 45 | +- **Adapter Example Pages** - Revamped all adapter example pages with complete runnable snippets and standardised |
| 46 | + sections (Installation, Configuration, Basic Usage, See Also). |
| 47 | + - Added Elasticsearch example guide and expanded PostgreSQL and configs examples |
| 48 | + - Consolidated payment gateway documentation into a single page |
| 49 | +- **New Example Pages** - Added `dependency_injection.md` and `error_handling.md` example guides. |
| 50 | +- **Getting Started** - Overhauled the quickstart guide and complete user example to reflect `manage.py` integration; |
| 51 | + updated project structure documentation with enhanced `run` command options. |
| 52 | +- **Navigation** - Restructured and expanded `mkdocs.yml` navigation; added `404.md` and `CODE_OF_CONDUCT.md` pages. |
| 53 | +- **Architecture & Concepts** - Updated architecture and concepts documentation; split the large `concepts.md` into |
| 54 | + focused topic pages. |
| 55 | +- **Installation Guide** - Created a dedicated installation guide and streamlined the prerequisites section. |
| 56 | +- **Changelog** - Added Cursor rules for changelog standards and restructured changelog organisation and navigation. |
0 commit comments