Architecture Decision Records
This directory contains Architecture Decision Records (ADRs) for the SlaunchX backend platform. ADRs capture significant architectural decisions, their context, and consequences.
Format
Each ADR follows a standard template with sections: Status, Date, Context, Decision, Consequences, and Alternatives Considered.
# ADR-NNNN: <Title>
Status | Date | Supersedes | Superseded by
Context | Decision | Consequences | Alternatives ConsideredScope
- Module-scoped ADRs apply to the backend-platform repository.
- Workspace-scoped ADRs (marked
Scope: workspace) apply across multiple repositories in the SlaunchX workspace.
Index
| ADR | Title | Date | Scope | Source |
|---|---|---|---|---|
| ADR-0001 | Lockstep Versioning Across All Modules | 2026-03-18 | module | docs/versioning-policy.md |
| ADR-0002 | Deny-by-Default Gateway Chain Routing | 2026-03-22 | module | Gateway MODULE-SPEC, DESIGN docs |
| ADR-0003 | Session-Scoped JWT Signing (SCv2) | 2026-03-19 | module | SCv2 crypto hardfix spec |
| ADR-0004 | AST Parser Over Regex for API Documentation | 2026-03-27 | workspace | DevPortal design spec (AD-2, Q1) |
| ADR-0005 | POST Body Over Path Variables for Resource Operations | 2026-03-23 | module | Workspace context header spec |
| ADR-0006 | VitePress for Both Internal Wiki and External API Docs | 2026-03-27 | workspace | DevPortal design spec (AD-6) |
| ADR-0007 | Mono-Repo for Multi-Language SDKs | 2026-03-27 | workspace | DevPortal design spec (AD-5) |
| ADR-0008 | Hand-Written SDK + Template-Generated Docs | 2026-03-27 | workspace | DevPortal design spec (AD-3) |
| ADR-0009 | Portal x Chain Matrix as Access Control Model | 2026-03-22 | module | Gateway MODULE-SPEC, DevPortal spec |
| ADR-0010 | EN-Source + Auto-Translated ZH Bilingual Strategy | 2026-03-27 | workspace | Documentation system standard |
| ADR-0011 | Per-Portal Controller Isolation | 2026-03-22 | module | Portal controller split specs |
| ADR-0012 | Workspace Context via Header, Not Path Variable | 2026-03-23 | module | Workspace context header spec |
| ADR-0013 | Separate API Toolkit Project (No SpringDoc) | 2026-03-27 | workspace | DevPortal design spec (AD-1) |
Adding New ADRs
- Use the next available number:
ADR-NNNN - File naming:
ADR-NNNN-<slug>.md(lowercase, hyphen-separated) - Set status to
PROPOSEDfor new decisions,ACCEPTEDafter review - Include the source spec or discussion reference in the Context section
- For cross-repo decisions, add
Scope: workspacein the status block