Skip to content

Update docs to Material theme and 1.0 compatibility#778

Merged
abrookins merged 3 commits intomainfrom
docs-material-theme-and-1.0-updates
Jan 22, 2026
Merged

Update docs to Material theme and 1.0 compatibility#778
abrookins merged 3 commits intomainfrom
docs-material-theme-and-1.0-updates

Conversation

@abrookins
Copy link
Copy Markdown
Collaborator

Summary

Updates the documentation site with a modern Material for MkDocs theme and ensures all code examples are compatible with Redis OM 1.0.

Changes

Theme & Structure

  • Switch to Material for MkDocs theme with Redis branding (red color scheme, dark/light mode)
  • Add custom styling for code blocks, tables, and feature cards
  • Reorganize navigation into Getting Started, User Guide, and Reference sections
  • Combine connections.md and redis_modules.md into a single redis_setup.md page
  • Recommend Redis 8 as the preferred Redis version

1.0 Code Example Updates

  • Add model-level index=True to all indexed model examples
  • Update Pydantic validators to v2 syntax (__get_pydantic_core_schema__ instead of __get_validators__)
  • Update error message formats to Pydantic v2 style
  • Replace deprecated @app.on_event("startup") with lifespan context manager in FastAPI examples
  • Replace Migrator().run() references with om migrate CLI

Files Changed

  • mkdocs.yml - Theme configuration and navigation
  • docs/index.md - Updated landing page and model example
  • docs/getting_started.md - Docker images, validators, error messages
  • docs/validation.md - Error message formats
  • docs/fastapi_integration.md - Lifespan pattern for startup
  • docs/migrations.md - Model-level indexing
  • docs/redis_setup.md - New combined page (replaces connections.md and redis_modules.md)
  • docs/stylesheets/extra.css - Custom styling
  • README.md - Updated link to redis_setup.md

Co-authored by Augment Code

- Switch to Material for MkDocs theme with Redis branding
- Combine connections.md and redis_modules.md into redis_setup.md
- Recommend Redis 8 over Redis Stack
- Update all code examples for 1.0:
  - Add model-level index=True to indexed models
  - Update Pydantic validators to v2 syntax
  - Update error message formats to Pydantic v2 style
  - Replace @app.on_event with lifespan pattern in FastAPI examples
  - Replace Migrator().run() with om migrate CLI reference
@abrookins abrookins merged commit 979e74b into main Jan 22, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant