From 6dbeb5e9ecb852d3284215f012710d3a31e9de4f Mon Sep 17 00:00:00 2001 From: Andrew Brookins Date: Wed, 24 Nov 2021 07:18:03 -0800 Subject: [PATCH] Add documentation index page --- docs/getting_started.md | 1 - docs/index.md | 21 +++++++++++++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 docs/index.md diff --git a/docs/getting_started.md b/docs/getting_started.md index 9450463..6654cdf 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -399,7 +399,6 @@ You might wonder what qualifies as a "date" in our last validation example. By d ```python import datetime -from typing import Optional from redis_om import HashModel diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e33ce23 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,21 @@ +# Redis OM for Python + +Welcome! This is the index of documentation for redis-om-python. + +**NOTE**: The documentation is a bit sparse at the moment but will continue to grow! + +## Getting Started + +Read the Getting Started tutorial at [getting_started.md](getting_started.md). + +## Validating Data + +Read about how to use Redis OM models to validate data at [validation.md](validation.md) + +## Redis Modules + +Read how to get the RediSearch and RedisJSON modules at [redis_modules.md](redis_modules.md). + +## FastAPI Integration + +Redis OM is designed to integrate with the FastAPI web framework. See how this works at [fastapi_integration.md](fastapi_integration.md).