From 613b43882bef43d7e5758ea55d35b6ea02acfd2a Mon Sep 17 00:00:00 2001 From: Andrew Brookins Date: Fri, 23 Jan 2026 12:10:43 -0800 Subject: [PATCH 1/3] Add docs link to README and logo to docs homepage - Add prominent documentation links near the top of README - Update doc links in README to use docs site URL instead of file paths - Add logo to docs homepage --- README.md | 8 +++++--- docs/index.md | 4 ++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ca11e7aa..92125d23 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ **Redis OM Python** makes it easy to model Redis data in your Python applications. +📖 **[Read the Documentation](https://redis.github.io/redis-om-python/)** | 🚀 **[Getting Started](https://redis.github.io/redis-om-python/getting_started/)** + [Redis OM .NET](https://github.com/redis/redis-om-dotnet) | [Redis OM Node.js](https://github.com/redis/redis-om-node) | [Redis OM Spring](https://github.com/redis/redis-om-spring) | **Redis OM Python**
@@ -152,7 +154,7 @@ andrew.expire(120) assert Customer.get(andrew.pk) == andrew ``` -**Ready to learn more?** Check out the [getting started](docs/getting_started.md) guide. +**Ready to learn more?** Check out the [getting started](https://redis.github.io/redis-om-python/getting_started/) guide. Or, continue reading to see how Redis OM makes data validation a snap. @@ -202,7 +204,7 @@ except ValidationError as e: **Any existing Pydantic validator should work** as a drop-in type annotation with a Redis OM model. You can also write arbitrarily complex custom validations! -To learn more, see the [documentation on data validation](docs/validation.md). +To learn more, see the [documentation on data validation](https://redis.github.io/redis-om-python/validation/). ## 🔎 Rich Queries and Embedded Models @@ -366,7 +368,7 @@ Some advanced features of Redis OM rely on core features from two source availab You can run these modules in your self-hosted Redis deployment, or you can use [Redis Enterprise][redis-enterprise-url], which includes both modules. -To learn more, read [our documentation](docs/redis_setup.md). +To learn more, read [our documentation](https://redis.github.io/redis-om-python/redis_setup/). ## Connecting to Azure Managed Redis with EntraID diff --git a/docs/index.md b/docs/index.md index 8d703bcd..1f3f441a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +
+ Redis OM Python +
+ # Redis OM Python

From 1e8bed4521eaabe0e816502d517fc0afa578f084 Mon Sep 17 00:00:00 2001 From: Andrew Brookins Date: Fri, 23 Jan 2026 12:12:07 -0800 Subject: [PATCH 2/3] Add bug fixes to 1.0 release notes --- docs/release_notes_1.0.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/release_notes_1.0.md b/docs/release_notes_1.0.md index 0010cfff..3fc9b358 100644 --- a/docs/release_notes_1.0.md +++ b/docs/release_notes_1.0.md @@ -55,6 +55,11 @@ Full mypy compatibility with PEP 561 py.typed marker. - Fixed Python 3.14 dict iteration error in JsonModel - Fixed broken redis.io documentation URLs - Fixed Pydantic V3 deprecation warnings +- Fixed inconsistent `.pk` behavior with custom primary keys (#570) +- Fixed HashModel list validation blocking vector fields (#544, #552) +- Fixed OR expression with KNN producing syntax error (#557) +- Fixed bytes fields failing with UnicodeDecodeError (#779) +- Fixed CLI `import_submodules` not working with pyenv (#682) ## Dependency Updates From 02cc77c3e2d5579076677be1e7854d0e591f9e1c Mon Sep 17 00:00:00 2001 From: Andrew Brookins Date: Fri, 23 Jan 2026 12:14:03 -0800 Subject: [PATCH 3/3] Add UnicodeDecodeError to spellcheck wordlist --- .github/wordlist.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/wordlist.txt b/.github/wordlist.txt index d81fd19c..08781481 100644 --- a/.github/wordlist.txt +++ b/.github/wordlist.txt @@ -111,4 +111,5 @@ ulid coroutine compat programmatically -uv \ No newline at end of file +uv +UnicodeDecodeError \ No newline at end of file