Update documentation with health and ready checks endpoints

Author: rragundez

docs/getting-started/first-run.md

@@ -38,8 +38,28 @@ curl http://localhost:8000/api/v1/health
 Expected response:
 ```json
 {
-  "status": "healthy",
-  "timestamp": "2024-01-01T12:00:00Z"
+  "status":"healthy",
+  "environment":"local",
+  "version":"0.1.0",
+  "timestamp":"2025-10-21T14:40:14+00:00"
+}
+```
+
+**Ready Check:**
+```bash
+curl http://localhost:8000/api/v1/ready
+```
+
+Expected response:
+```json
+{
+  "status":"healthy",
+  "environment":"local",
+  "version":"0.1.0",
+  "app":"healthy",
+  "database":"healthy",
+  "redis":"healthy",
+  "timestamp":"2025-10-21T14:40:47+00:00"
 }
 ```
 

docs/getting-started/index.md

@@ -104,6 +104,7 @@ Visit these URLs to confirm everything is working:
 - **API Documentation**: [http://localhost:8000/docs](http://localhost:8000/docs)
 - **Alternative Docs**: [http://localhost:8000/redoc](http://localhost:8000/redoc)
 - **Health Check**: [http://localhost:8000/api/v1/health](http://localhost:8000/api/v1/health)
+- **Ready Check**: [http://localhost:8000/api/v1/ready](http://localhost:8000/api/v1/ready)
 
 ## You're Ready!
 
@@ -126,7 +127,12 @@ Try these quick tests to see your API in action:
 curl http://localhost:8000/api/v1/health
 ```
 
-### 2. Create a User
+### 2. Ready Check
+```bash
+curl http://localhost:8000/api/v1/ready
+```
+
+### 3. Create a User
 ```bash
 curl -X POST "http://localhost:8000/api/v1/users" \
   -H "Content-Type: application/json" \
@@ -138,7 +144,7 @@ curl -X POST "http://localhost:8000/api/v1/users" \
   }'
 ```
 
-### 3. Login
+### 4. Login
 ```bash
 curl -X POST "http://localhost:8000/api/v1/login" \
   -H "Content-Type: application/x-www-form-urlencoded" \

docs/getting-started/installation.md

@@ -290,9 +290,10 @@ After installation, verify everything works:
 
 1. **API Documentation**: http://localhost:8000/docs
 2. **Health Check**: http://localhost:8000/api/v1/health
-3. **Database Connection**: Check logs for successful connection
-4. **Redis Connection**: Test caching functionality
-5. **Background Tasks**: Submit a test job
+3. **Ready Check**: http://localhost:8000/api/v1/ready
+4. **Database Connection**: Check logs for successful connection
+5. **Redis Connection**: Test caching functionality
+6. **Background Tasks**: Submit a test job
 
 ## Troubleshooting
 

docs/user-guide/configuration/environment-variables.md

@@ -526,21 +526,6 @@ if settings.ENABLE_ADVANCED_CACHING:
     pass
 ```
 
-### Health Checks
-
-Configure health check endpoints:
-
-```python
-@app.get("/health")
-async def health_check():
-    return {
-        "status": "healthy",
-        "database": await check_database_health(),
-        "redis": await check_redis_health(),
-        "version": settings.APP_VERSION
-    }
-```
-
 ## Configuration Validation
 
 ### Environment Validation

docs/user-guide/production.md

@@ -318,6 +318,13 @@ http {
             access_log off;
         }
 
+        # Ready check endpoint (no rate limiting)
+        location /ready {
+            proxy_pass http://fastapi_backend;
+            proxy_set_header Host $host;
+            access_log off;
+        }
+
         # Static files (if any)
         location /static/ {
             alias /code/static/;
@@ -554,49 +561,6 @@ DEFAULT_RATE_LIMIT_LIMIT = 100  # requests per period
 DEFAULT_RATE_LIMIT_PERIOD = 3600  # 1 hour
 ```
 
-### Health Checks
-
-#### Application Health Check
-
-```python
-# src/app/api/v1/health.py
-from fastapi import APIRouter, Depends, HTTPException
-from sqlalchemy.ext.asyncio import AsyncSession
-from ...core.db.database import async_get_db
-from ...core.utils.cache import redis_client
-
-router = APIRouter()
-
-@router.get("/health")
-async def health_check():
-    return {"status": "healthy", "timestamp": datetime.utcnow()}
-
-@router.get("/health/detailed")
-async def detailed_health_check(db: AsyncSession = Depends(async_get_db)):
-    health_status = {"status": "healthy", "services": {}}
-    
-    # Check database
-    try:
-        await db.execute("SELECT 1")
-        health_status["services"]["database"] = "healthy"
-    except Exception:
-        health_status["services"]["database"] = "unhealthy"
-        health_status["status"] = "unhealthy"
-    
-    # Check Redis
-    try:
-        await redis_client.ping()
-        health_status["services"]["redis"] = "healthy"
-    except Exception:
-        health_status["services"]["redis"] = "unhealthy"
-        health_status["status"] = "unhealthy"
-    
-    if health_status["status"] == "unhealthy":
-        raise HTTPException(status_code=503, detail=health_status)
-    
-    return health_status
-```
-
 ### Deployment Process
 
 #### CI/CD Pipeline (GitHub Actions)