Add documentation index page
This commit is contained in:
parent
436c6500af
commit
6dbeb5e9ec
2 changed files with 21 additions and 1 deletions
|
@ -399,7 +399,6 @@ You might wonder what qualifies as a "date" in our last validation example. By d
|
||||||
|
|
||||||
```python
|
```python
|
||||||
import datetime
|
import datetime
|
||||||
from typing import Optional
|
|
||||||
|
|
||||||
from redis_om import HashModel
|
from redis_om import HashModel
|
||||||
|
|
||||||
|
|
21
docs/index.md
Normal file
21
docs/index.md
Normal file
|
@ -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).
|
Loading…
Reference in a new issue