Reorganize docs and switch to ruff (#804)

* Reorganize docs and switch to ruff

* Add technical terms to spellcheck wordlist

Author: abrookins

.github/wordlist.txt

@@ -125,3 +125,8 @@ UUID
 lexicographically
 Lexicographically
 backport
+TTL
+queryable
+substring
+NotFoundError
+QueryNotSupportedError

Makefile

@@ -19,6 +19,7 @@ help:
 	@echo "  redis       start a Redis instance with Docker"
 	@echo "  sync        generate modules redis_om, tests_sync from aredis_om, tests respectively"
 	@echo "  dist        build a redis-om package"
+	@echo "  docs        start the docs server locally for preview"
 	@echo "  all         equivalent to \"make lint format test\""
 	@echo ""
 	@echo "Check the Makefile to know exactly what each target is doing."
@@ -49,17 +50,16 @@ sync: $(INSTALL_STAMP)
 	$(UV) run python make_sync.py
 
 .PHONY: lint
-lint: $(INSTALL_STAMP) dist
-	$(UV) run isort --profile=black --lines-after-imports=2 ./tests/ $(NAME) $(SYNC_NAME)
-	$(UV) run black ./tests/ $(NAME)
-	$(UV) run flake8 --ignore=E231,E501,E712,E731,F401,W503 ./tests/ $(NAME) $(SYNC_NAME)
+lint: $(INSTALL_STAMP) sync
+	$(UV) run ruff check ./tests/ $(NAME) $(SYNC_NAME)
+	$(UV) run ruff format --check ./tests/ $(NAME) $(SYNC_NAME)
 	$(UV) run mypy ./tests/ --ignore-missing-imports --exclude migrate.py --exclude _compat\.py$$
 	$(UV) run bandit -r $(NAME) $(SYNC_NAME) -s B608
 
 .PHONY: format
 format: $(INSTALL_STAMP) sync
-	$(UV) run isort --profile=black --lines-after-imports=2 ./tests/ $(NAME) $(SYNC_NAME)
-	$(UV) run black ./tests/ $(NAME) $(SYNC_NAME)
+	$(UV) run ruff check --fix ./tests/ $(NAME) $(SYNC_NAME)
+	$(UV) run ruff format ./tests/ $(NAME) $(SYNC_NAME)
 
 .PHONY: test
 test: $(INSTALL_STAMP) sync redis
@@ -77,5 +77,9 @@ test_oss: $(INSTALL_STAMP) sync redis
 redis:
 	docker compose up -d
 
+.PHONY: docs
+docs: $(INSTALL_STAMP)
+	$(UV) run mkdocs serve
+
 .PHONY: all
 all: lint format test

aredis_om/__init__.py

@@ -19,6 +19,7 @@
 )
 from .model.types import Coordinates, GeoFilter
 
+
 # Backward compatibility alias - deprecated, use SchemaDetector or SchemaMigrator
 Migrator = SchemaDetector
 

aredis_om/model/model.py

@@ -24,7 +24,9 @@
     Union,
 )
 from typing import get_args as typing_get_args
-from typing import no_type_check
+from typing import (
+    no_type_check,
+)
 
 from more_itertools import ichunked
 from pydantic import BaseModel

docs/migrations.md

@@ -18,12 +18,8 @@ If you're upgrading from Redis OM Python 0.x to 1.0, see the **[0.x to 1.0 Migra
 ## CLI Commands
 
 ```bash
-# Schema migrations (recommended)
 om migrate          # File-based schema migrations with rollback support
 om migrate-data     # Data migrations and transformations
-
-# Legacy command (deprecated)
-migrate             # Automatic schema migrations (use om migrate instead)
 ```
 
 ## Schema Migrations
@@ -57,24 +53,6 @@ om migrate run
 om migrate run --migrations-dir myapp/schema-migrations
 ```
 
-> **Note**: The legacy `migrate` command performs automatic migrations without file tracking and is deprecated. Use `om migrate` for production deployments.
-
-### Migration Approaches
-
-Redis OM provides two approaches to schema migrations:
-
-#### File-based Migrations (`om migrate`) - Recommended
-- **Controlled**: Migrations are saved as versioned files
-- **Rollback**: Previous schemas can be restored
-- **Team-friendly**: Migration files can be committed to git
-- **Production-safe**: Explicit migration approval workflow
-
-#### Automatic Migrations (`migrate`) - Deprecated  
-- **Immediate**: Detects and applies changes instantly
-- **No rollback**: Cannot undo schema changes
-- **Development-only**: Suitable for rapid prototyping
-- **⚠️ Deprecated**: Use `om migrate` for production
-
 ### How File-based Migration Works
 
 1. **Detection**: Auto-migrator detects index changes from your models