Update docs to Material theme and 1.0 compatibility#778
Merged
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
connections.mdandredis_modules.mdinto a singleredis_setup.mdpage1.0 Code Example Updates
index=Trueto all indexed model examples__get_pydantic_core_schema__instead of__get_validators__)@app.on_event("startup")withlifespancontext manager in FastAPI examplesMigrator().run()references withom migrateCLIFiles Changed
mkdocs.yml- Theme configuration and navigationdocs/index.md- Updated landing page and model exampledocs/getting_started.md- Docker images, validators, error messagesdocs/validation.md- Error message formatsdocs/fastapi_integration.md- Lifespan pattern for startupdocs/migrations.md- Model-level indexingdocs/redis_setup.md- New combined page (replaces connections.md and redis_modules.md)docs/stylesheets/extra.css- Custom stylingREADME.md- Updated link to redis_setup.mdCo-authored by Augment Code