Skip to content

Commit 6dbeb5e

Browse files
author
Andrew Brookins
committed
Add documentation index page
1 parent 436c650 commit 6dbeb5e

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

docs/getting_started.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,6 @@ You might wonder what qualifies as a "date" in our last validation example. By d
399399

400400
```python
401401
import datetime
402-
from typing import Optional
403402

404403
from redis_om import HashModel
405404

docs/index.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Redis OM for Python
2+
3+
Welcome! This is the index of documentation for redis-om-python.
4+
5+
**NOTE**: The documentation is a bit sparse at the moment but will continue to grow!
6+
7+
## Getting Started
8+
9+
Read the Getting Started tutorial at [getting_started.md](getting_started.md).
10+
11+
## Validating Data
12+
13+
Read about how to use Redis OM models to validate data at [validation.md](validation.md)
14+
15+
## Redis Modules
16+
17+
Read how to get the RediSearch and RedisJSON modules at [redis_modules.md](redis_modules.md).
18+
19+
## FastAPI Integration
20+
21+
Redis OM is designed to integrate with the FastAPI web framework. See how this works at [fastapi_integration.md](fastapi_integration.md).

0 commit comments

Comments
 (0)