Skip to content

Conversation

@smoreinis
Copy link
Collaborator

Summary

Adds comprehensive internal architecture documentation for developers working on the Agentex backend.

Diagrams Included

  • High-level Architecture - Hexagonal/Clean architecture with all layers
  • Request Flow - Sequence diagram showing request lifecycle
  • Domain Layer - Use Cases → Services → Repositories relationships
  • Data Storage Split - PostgreSQL vs MongoDB vs Redis vs Temporal
  • API Routes - All 10 route files overview
  • Middleware Stack - Execution order with fast path for health checks

Location

docs/docs/development_guides/architecture.md

Added to MkDocs nav under "Development Guides → Internal Architecture"

Preview

The diagrams use Mermaid (already configured in mkdocs.yml) for visual representation.

Add comprehensive architecture documentation for developers:
- High-level hexagonal architecture overview
- Request flow sequence diagram
- Domain layer structure (Use Cases → Services → Repositories)
- Data storage split (PostgreSQL, MongoDB, Redis, Temporal)
- API routes overview
- Middleware stack execution order
- Key files reference table

Uses Mermaid diagrams for visual representation.
Remove numbered prefixes (1., 2., etc.) that were being interpreted
as markdown lists. Use dashes instead of <br/> for descriptions.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants