Flow

Repository map

Where services, platform docs, and the documentation portal live in this repository.

Top-level layout

PathWhat it is
services/<name>/A deployable Go service with its own database, migrations, and handlers
docs/Binding platform design (architecture.md), local dev, ADRs, and accounting domain notes
frontend/docs-app/This documentation portal (Next.js + Fumadocs MDX)
frontend/devops-app/, frontend/intelligence-app/, frontend/local-app/Flow MUI consoles (Next.js + SCSS modules)
frontend/seed/Drop-in theme, fonts, and agent skill for a new Flow MUI app
MakefileLocal dev orchestration: Compose, migrations, tests, OpenAPI merge
openapi.yamlMerged platform spec (deployed services only; template is excluded today)

Services today

Platform docs outside the portal

Some material still lives under docs/ at the repository root:

  • docs/architecture.md — binding design; read before changing storage, transport, events, or authz
  • docs/decisions/ — ADRs with alternatives and reasoning (also in the docs portal)
  • docs/toolchain.md — stack choices
  • docs/accounting/ — chart-of-accounts domain design and open questions

The portal summarizes and links to these; when they disagree with running code, code wins.

Reference service vs production service

template is copied to start new services. Its sample domains (domain1, domain2) are throwaway; the wiring (Postgres, idempotent commands, transactional outbox, enveloped HTTP, Service Bus publisher) is what matters.

accounting is the first real service. It implements the chart of accounts slice and publishes account.created events. The ledger package exists as a placeholder for the next slice.

Reference frontend vs live app

seed is copied to start a new Flow MUI app. It ships the theme stack, fonts, Cursor rules, and the flow-frontend agent skill. It is not a runnable app.

devops-app and intelligence-app are the live references for shell, providers, and services. docs-app is this portal and uses Fumadocs, not that theme stack. The skill lives at frontend/seed/.cursor/skills/flow-frontend/SKILL.md and is linked from .cursor/skills/, .claude/skills/, and .agents/skills/ at the repository root.

On this page