Skip to content

Commit 57a8f84

Browse files
docs: add release notes for version 4.3.6 with updates to SQLAlchemy filters and documentation overhaul
1 parent 270bb91 commit 57a8f84

4 files changed

Lines changed: 59 additions & 2 deletions

File tree

docs/community/changelog/4/4.3.5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Release notes for ArchiPy 4.3.5"
55

66
# 4.3.5 — 2026-03-10
77

8-
[4.3.4 →](4.3.4.md) | [↑ 4.x series](index.md)
8+
[← 4.3.6](4.3.6.md) | [4.3.4 →](4.3.4.md) | [↑ 4.x series](index.md)
99

1010
## Fixed
1111

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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.

docs/community/changelog/4/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ description: "Release history for ArchiPy 4.x series"
99

1010
| Version | Date | Summary |
1111
|-------------------|------------|-------------------------------------------------------------------------------------------------|
12+
| [4.3.6](4.3.6.md) | 2026-03-13 | SQLAlchemy filter type expansion, docs overhaul, CI pipeline fixes |
1213
| [4.3.5](4.3.5.md) | 2026-03-10 | SSL Config Typing: Improved type safety and optional-field handling for SSL configuration in... |
1314
| [4.3.4](4.3.4.md) | 2026-02-24 | BaseError `__str__` Enhancement: Improved string representation to expose full error context |
1415
| [4.3.3](4.3.3.md) | 2026-02-23 | Type-Safe Field References: Reverted the experimental type-safe field references feature |

docs/community/changelog/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ All notable changes to ArchiPy are documented here, organized by major version s
99

1010
## [4.x Series](4/index.md)
1111

12-
12 releases — from 4.0.0 to 4.3.5
12+
13 releases — from 4.0.0 to 4.3.6
1313

1414
## [3.x Series](3/index.md)
1515

0 commit comments

Comments
 (0)