Skip to content

SaaS-Courier Documentation

RoundAway Express - Technical Documentation Hub

Quick Navigation by Role

🤖 For Backend Agent

START HERE: backend/README.md
API CONTRACT: api-contract/README.md
DATABASE: backend/database-schema.md
PROBLEMS: Consult saas-backend/PROBLEMS.md before development

🎨 For Frontend Agent

START HERE: frontend/README.md
API CONTRACT: api-contract/README.md
DESIGN: frontend/design-system.md
FLET BEST PRACTICES: frontend/flet-best-practices.md
PROBLEMS: Consult saas-fronted/PROBLEMS.md before development

📋 For Product/PM

PRD SUMMARY: product/prd-summary.md
FEATURES: product/features.md
USER ROLES: product/user-roles.md
CHANGELOG: product/changelog.md

🔧 For Operations

DOCKER: operations/docker.md
TROUBLESHOOTING: operations/troubleshooting.md
MIGRATIONS: operations/migrations.md
MONITORING: operations/monitoring.md

Knowledge Map

📁 1. Concepts (WHAT THE SYSTEM IS)

File Description
domain-model.md Core entities and relationships
workflows.md Business process flows
glossary.md Terms and definitions
adr/ Why decisions were made

📁 2. API Contract (FRONTEND-BACKEND INTEGRATION)

File Description
README.md Frontend quick start
auth.md Auth endpoints and tokens
endpoints.md All API endpoints
websockets.md Real-time events
public-tracking.md Public tracking API

📁 3. Backend (PYTHON/FASTAPI)

File Description
README.md Backend quick start
modules.md Module structure
database-schema.md DB tables and ERD
services.md External integrations
deployment.md Production deployment
testing.md Testing strategy

📁 4. Frontend (FLET/PYTHON)

File Description
README.md Frontend quick start
architecture.md Clean Architecture
design-system.md Colors, typography
components.md UI components
flet-best-practices.md Flet guidelines
i18n.md Translations

📁 5. Operations (RUNBOOK)

File Description
README.md Operations overview
docker.md Docker setup
monitoring.md Logging & metrics
troubleshooting.md Common issues
migrations.md DB migrations

📁 6. Product

File Description
README.md Product overview
prd-summary.md Executive summary
features.md Feature list
user-roles.md Roles & permissions

📁 7. Security

File Description
README.md Security overview
authentication.md Auth mechanisms
authorization.md RBAC & permissions
rate-limiting.md Rate limits
owasp.md OWASP compliance

Documentation Rules for Agents

saas-backend Agent

  1. Before development: Read saas-backend/PROBLEMS.md and saas-backend/CHANGELOG.md
  2. Check VERSION: Current version in saas-backend/VERSION
  3. After fix: Document in saas-backend/problems/PROBLEM-XXX.md

saas-frontend Agent

  1. Before development: Read saas-fronted/PROBLEMS.md and saas-fronted/CHANGELOG.md
  2. Check VERSION: Current version in saas-fronted/VERSION
  3. After fix: Document in saas-fronted/problems/PROBLEM-XXX.md

External Resources

🤖 Quick Reference for Agents

Si eres un agente (@backend_dev, @frontend_dev, @architect, etc.), usa esta tabla para saber qué leer según tu tarea:

Tarea Leer primero...
Crear un endpoint API Contract → Backend Modules
Crear una migración Database Schema → Migrations
Actualizar schema Pydantic Domain Model → API Contract
Diseñar un componente UI Design System → Components
Implementar auth/roles Authentication → Authorization
Debuggear un problema Troubleshooting + PROBLEMS.md del repo
Hacer deploy Deployment → Docker
Diseñar DB (architect) Domain Model → ER Diagram
Escribir tests Testing → mirar tests existentes en tests/
Revisar seguridad OWASP → Rate Limiting

Reglas globales: Cada agente las tiene inyectadas en su archivo .opencode/agents/. No hace falta leer AGENTS_GLOBAL.md.