Skip to content

Commit 2ac6d9f

Browse files
committed
improve docs for backends
1 parent e35ebe5 commit 2ac6d9f

File tree

3 files changed

+770
-6
lines changed

3 files changed

+770
-6
lines changed

docs/usage/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ admin = CRUDAdmin(
8383

8484
- Use strong, randomly generated secret keys.
8585
- Use environment variables for all sensitive configuration.
86-
- Use a robust session backend like Redis: `uv add "crudadmin[redis]"`
86+
- Use a robust session backend like Redis: `uv add "crudadmin[redis]"` (see [Session Backends](session-backends.md))
8787
- Enable HTTPS and secure cookies to protect data in transit.
8888
- Set up proper logging and monitoring to detect security events.
8989

docs/usage/overview.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,21 @@ This section guides you through everything you need to know about using CRUDAdmi
88
Learn how to set up and configure your CRUDAdmin instance for different environments.
99

1010
- **Creating your first admin interface** with essential settings
11-
- **Session backend configuration** (Memory, Redis, Memcached, Database, Hybrid)
1211
- **Security settings** for authentication and access control
1312
- **Environment-based configuration** for development vs production
1413
- **FastAPI integration** patterns and best practices
1514

16-
### 2. [Adding Models](adding-models.md)
15+
### 2. [Session Backends](session-backends.md)
16+
Master session management with flexible backend options for optimal performance.
17+
18+
- **Memory sessions** for development and testing
19+
- **Redis sessions** for production and high-traffic applications
20+
- **Memcached sessions** for high-performance caching
21+
- **Database sessions** for audit trails and compliance
22+
- **Hybrid sessions** combining performance with auditability
23+
- **Dynamic backend switching** and environment-based configuration
24+
25+
### 3. [Adding Models](adding-models.md)
1726
Master the core functionality of registering your SQLAlchemy models with CRUDAdmin.
1827

1928
- **Model registration** with create, update, and read schemas
@@ -22,15 +31,15 @@ Master the core functionality of registering your SQLAlchemy models with CRUDAdm
2231
- **Advanced schema configuration** for different operations
2332
- **Real-world examples** and troubleshooting tips
2433

25-
### 3. [Managing Admin Users](admin-users.md)
34+
### 4. [Managing Admin Users](admin-users.md)
2635
Set up authentication and manage who can access your admin interface.
2736

2837
- **Creating admin users** and managing credentials
2938
- **Authentication flow** and session management
3039
- **User roles and permissions** (if applicable)
3140
- **Security best practices** for admin access
3241

33-
### 4. [Using the Interface](interface.md)
42+
### 5. [Using the Interface](interface.md)
3443
Navigate and operate the admin interface effectively for daily tasks.
3544

3645
- **Dashboard navigation** and understanding the layout
@@ -39,7 +48,7 @@ Navigate and operate the admin interface effectively for daily tasks.
3948
- **Bulk operations** for managing multiple records
4049
- **Form handling** and validation
4150

42-
### 5. [Common Patterns](common-patterns.md)
51+
### 6. [Common Patterns](common-patterns.md)
4352
Real-world usage patterns and scenarios you'll encounter in practice.
4453

4554
- **Multi-model relationships** (blog systems, e-commerce catalogs)
@@ -62,6 +71,7 @@ After completing the Usage section, you'll have a solid foundation for building
6271
Need to jump to a specific topic? Here are the most commonly accessed sections:
6372

6473
- **[Quick setup example](configuration.md#basic-example)** - Get running in 5 minutes
74+
- **[Session backends](session-backends.md#redis-sessions)** - Configure Redis for production
6575
- **[Adding your first model](adding-models.md#basic-model-registration)** - Register a model and start managing data
6676
- **[Search and filtering](interface.md#search-and-filtering)** - Find records quickly
6777
- **[Performance tips](common-patterns.md#performance-optimization-patterns)** - Optimize for large datasets

0 commit comments

Comments
 (0)