Docs Cleanup
This commit is contained in:
@@ -14,11 +14,11 @@ MotoVaultPro uses a 4-agent team for optimal development velocity and quality en
|
||||
- Platform service integration
|
||||
- Backend tests and migrations
|
||||
|
||||
**Platform Service Agent** - Independent microservices
|
||||
- Building new platform services in `mvp-platform-services/{service}/`
|
||||
- FastAPI microservice development
|
||||
- ETL pipelines and service databases
|
||||
- Platform service tests and deployment
|
||||
**Platform Feature Agent** - Integrated platform module
|
||||
- Enhancing `backend/src/features/platform/`
|
||||
- Vehicle lookup + VIN decoding logic
|
||||
- Redis/SQL performance tuning for platform endpoints
|
||||
- Platform module tests and documentation
|
||||
|
||||
**Mobile-First Frontend Agent** - Responsive UI/UX
|
||||
- React components in `frontend/src/features/{feature}/`
|
||||
@@ -45,10 +45,10 @@ Task: "Build responsive UI for {feature}. Read backend API docs and implement mo
|
||||
Test on 320px and 1920px viewports."
|
||||
Agent: Mobile-First Frontend Agent
|
||||
|
||||
# Platform microservice
|
||||
Task: "Create {service} platform microservice with FastAPI.
|
||||
Implement API, database, and health checks with tests."
|
||||
Agent: Platform Service Agent
|
||||
# Platform module work
|
||||
Task: "Enhance platform feature capsule (backend/src/features/platform).
|
||||
Implement API/domain/data changes with accompanying tests."
|
||||
Agent: Platform Feature Agent
|
||||
|
||||
# Quality validation
|
||||
Task: "Validate {feature} quality gates. Run all tests, check linting, verify mobile + desktop.
|
||||
@@ -109,11 +109,12 @@ Agent: Quality Enforcer Agent
|
||||
- Database: `backend/src/features/{feature}/data/`
|
||||
- After changes: `make rebuild` then check logs
|
||||
|
||||
### Platform Service Changes (Python)
|
||||
**Agent**: Platform Service Agent
|
||||
- Service: `mvp-platform-services/{service}/`
|
||||
- API: `mvp-platform-services/{service}/api/`
|
||||
- After changes: `make rebuild` then check service health
|
||||
### Platform Module Changes (TypeScript)
|
||||
**Agent**: Platform Feature Agent
|
||||
- Feature capsule: `backend/src/features/platform/`
|
||||
- API routes: `backend/src/features/platform/api/`
|
||||
- Domain/data: `backend/src/features/platform/domain/` and `data/`
|
||||
- After changes: `make rebuild` then verify platform endpoints via backend logs/tests
|
||||
|
||||
### Database Changes
|
||||
- Add migration: `backend/src/features/{feature}/migrations/00X_description.sql`
|
||||
@@ -159,12 +160,12 @@ Agent: Quality Enforcer Agent
|
||||
4. Ensure touch targets are 44px minimum
|
||||
5. Validate keyboard navigation on desktop
|
||||
|
||||
### Add Platform Service Integration
|
||||
**Agents**: Platform Service Agent + Feature Capsule Agent
|
||||
1. Platform Service Agent: Implement service endpoint
|
||||
2. Feature Capsule Agent: Create client in `external/platform-{service}/`
|
||||
3. Feature Capsule Agent: Add circuit breaker and caching
|
||||
4. Test integration with both agents
|
||||
### Add Platform Integration
|
||||
**Agents**: Platform Feature Agent + Feature Capsule Agent
|
||||
1. Platform Feature Agent: Implement/update platform endpoint logic
|
||||
2. Feature Capsule Agent: Update consuming feature client (e.g. `external/platform-vehicles/`)
|
||||
3. Feature Capsule Agent: Adjust caching/circuit breaker strategies as needed
|
||||
4. Joint testing: run targeted unit/integration suites
|
||||
5. Quality Enforcer Agent: Validate end-to-end
|
||||
|
||||
### Run Quality Checks
|
||||
@@ -188,9 +189,9 @@ Code is complete when:
|
||||
|
||||
## Architecture Quick Reference
|
||||
|
||||
### Hybrid Platform
|
||||
- **Platform Microservices**: Independent services in `mvp-platform-services/`
|
||||
- **Application Features**: Modular monolith in `backend/src/features/`
|
||||
### Application Stack
|
||||
- **Backend Feature Capsules**: Modular monolith in `backend/src/features/`
|
||||
- **Platform Module**: Vehicle data + VIN decoding in `backend/src/features/platform/`
|
||||
- **Frontend**: React SPA in `frontend/src/`
|
||||
|
||||
### Feature Capsule Pattern
|
||||
@@ -206,29 +207,21 @@ backend/src/features/{feature}/
|
||||
└── tests/ # Unit + integration tests
|
||||
```
|
||||
|
||||
### Platform Service Pattern
|
||||
Each service is independent:
|
||||
```
|
||||
mvp-platform-services/{service}/
|
||||
├── api/ # FastAPI application
|
||||
├── database/ # SQLAlchemy models + migrations
|
||||
└── tests/ # Service tests
|
||||
```
|
||||
|
||||
## Important Context
|
||||
|
||||
- **Auth**: Frontend uses Auth0, backend validates JWTs
|
||||
- **Database**: PostgreSQL with user-isolated data (user_id scoping)
|
||||
- **Platform APIs**: Authenticated via API keys (service-to-service)
|
||||
- **Platform APIs**: Exposed via `/api/platform/*`, secured with Auth0 JWTs
|
||||
- **Caching**: Redis with feature-specific TTL strategies
|
||||
- **Testing**: Jest (backend/frontend), pytest (platform services)
|
||||
- **Testing**: Jest (backend + frontend)
|
||||
- **Docker-First**: All development in containers (production-only)
|
||||
|
||||
## Agent Coordination Rules
|
||||
|
||||
### Clear Ownership
|
||||
- Feature Capsule Agent: Backend application features
|
||||
- Platform Service Agent: Independent microservices
|
||||
- Platform Feature Agent: Platform capsule inside backend
|
||||
- Mobile-First Frontend Agent: All UI/UX code
|
||||
- Quality Enforcer Agent: Testing and validation only
|
||||
|
||||
@@ -264,4 +257,4 @@ mvp-platform-services/{service}/
|
||||
- Testing: `docs/TESTING.md`
|
||||
- Context Loading: `.ai/context.json`
|
||||
- Development Guidelines: `CLAUDE.md`
|
||||
- Feature Documentation: `backend/src/features/{feature}/README.md`
|
||||
- Feature Documentation: `backend/src/features/{feature}/README.md`
|
||||
|
||||
Reference in New Issue
Block a user