This folder contains route-accurate workflow documentation per routed module.
Each module file describes:
- route inventory
- middleware/policy chain order
- handler -> service -> repository -> store flow
- transaction boundaries
- side effects (cache/rate-limit/auth/document-store)
- expected failure modes and troubleshooting checks
- auth.md
- home.md
- project.md
- artifacts.md
- resources.md
- pages.md
- calendar.md
- sidebar.md
- activity.md
- team.md
- health.md
- system.md
- ../architecture.md
- ../auth.md
- ../policies.md
- module workflow file you are changing
- ../routeDetails.md for generated route metadata snapshot
- Route notation:
METHOD /path - Policy chain order reflects runtime order as registered in
routes.go - Transaction notes indicate service-owned
store.WithTx(...)boundaries - Cache notes include read tags + invalidation scope where applicable
go test ./...
go build ./...
go run ./cmd/superapi-verify ./...If route stacks changed, regenerate route details:
go run ./cmd/routedocgen