Switchain Services — Documentation

This directory is the canonical home for shared repository documentation.

Sections

• System — Describes the running system: bounded contexts, state machines, events, flows, integrations, and runbooks.
• Conventions — Coding standards, architectural principles, and implementation patterns.
• Commands — Review workflows and slash-command references.
• Security — Incident analysis, security reviews, and vulnerability investigations.
• Decisions — Architecture decision records and durable trade-off decisions.
• Development — Plans, proposals, rollout notes, and other in-flight design work.

Where does this doc go?

• Rules and standards (how we write code) → conventions/.
• Descriptions of the running system (what a context does, how a state transitions, what triggers an event) → system/. Everything descriptive is centralized here; packages/ and apps/*/ stay code-only (ADR-002).
• In-flight proposals and plans → development/.
• Durable architectural decisions → decisions/readme.md.
• Security investigations and audits → security/.
• Slash-command workflows → commands/.