Busflow Docs

Internal documentation portal

Skip to content
Reviewed 04 May 2026

< Prev | Up: Session Overview | Next >

Session 3 β€” Architecture Standards ​

Goal: Confirm the technical architecture decisions are still current and internally consistent. Estimated time: 90 min

Reading Order ​

Read in this order β€” dependencies flow top-down:

#FileLinesWhat It Covers
1domain-driven-design.md159Bounded contexts, CQRS, cross-context patterns, context map.
2database.md (merged into domain-driven-design.md Β§3)β€”PostgreSQL strategy, schema separation, pgvector.
3frontend.md~65Vue 3/Nuxt/Quasar split, FSD layers, shared packages.
4app-structure.md292Workspace app feature layout, folder conventions, route structure.
5design-system.md122Component library, token system, Tailwind conventions.
6roles.md~110RBAC roles, capability model, role→frontend matrix.
7validation-strategy.md (merged into domain-driven-design.md Β§4)β€”Input validation layers, Valibot schemas, Hasura validation.
8monorepo.md151Turborepo pipeline, caching, Docker build strategy, pnpm.
9realtime-strategy.md153WebSocket, Hasura subscriptions, live updates.
10ai.md~100RAG pipeline, agent workflows, Paperclip, MCP bridge.
11communications.md~60Omnichannel inbox, notification pipeline, channel provisioning.
12workflow-orchestration.md282BullMQ, event triggers, scheduled jobs, worker patterns.
13gdpr-strategy.md~110Data retention, encryption, TTL policies, right to erasure.
14tests.md156Testing strategy, Vitest, Playwright, offline testing.

πŸ” What to Validate ​

  • [ ] domain-driven-design.md Β§8 Context Map: does each upstream/downstream relationship still hold?
  • [ ] roles.md: the Manager/Dispatcher/Driver trio β€” is the Driver auth flow documented anywhere?
  • [ ] ai.md references Paperclip for agentic company governance β€” is this still the chosen platform?
  • [ ] monorepo.md references Vercel Remote Cache as "planned" β€” still planned or dropped?
  • [ ] gdpr-strategy.md: does it cover the right-to-erasure implementation, or only the strategy?
  • [ ] tests.md: does the testing strategy match what tests actually exist in the repo today?
  • [ ] frontend.md lists apps/backoffice/ β€” does this app still exist, or was it merged into workspace?
  • [ ] design-system.md: does it reference Quasar's default UI bypass accurately? Is ShadCN-vue still chosen?
  • [x] validation-strategy.md at 3 KB β€” is this complete, or does it need expanding? Resolved: merged into domain-driven-design.md Β§4.
  • [ ] workflow-orchestration.md at 18 KB β€” does it still reflect the actual NestJS worker patterns?

πŸ—ΊοΈ Mindmap & Path Optimization ​

Grab your pen and paper:

  • [ ] Map the Data Flow: Draw how an incoming GraphQL request passes through validation, hits the database, triggers a Hasura event, and processes via BullMQ.
    • Observation: To understand this single flow, a developer must read domain-driven-design.md (Β§3–§5) + workflow-orchestration.md.
    • Optimization: Should we consolidate? Partially resolved: database.md and validation-strategy.md merged into domain-driven-design.md.
  • [ ] Check Frontend Fragmentation: How does a developer know where to put a Vue component?
    • Observation: They must cross-reference frontend.md (high-level), app-structure.md (292 lines of details), and design-system.md.
    • Optimization: Could we consolidate these into a single UI_ARCHITECTURE.md?

πŸ“ Findings & Actions ​

SeverityFile / TopicIssue & Optimization PotentialAction Required

< Prev | Up: Session Overview | Next >

Internal documentation β€” Busflow