View Markdown · Documentation index (llms.txt)
Learning Guide
Learn by building and explaining a working system, one architectural or domain decision at a time.
Start with How to learn with TraderX states, then choose a chapter below or explore the visual state diagram. Each chapter carries forward prior knowledge, introduces a concrete change, and asks you to explain the evidence you observe.
Canonical requirements, contracts, and architecture remain in specs/**.
These guides explain how to read each generated code snapshot, compare it to previous states, and understand the code delta in plain English.
For the visual progression map, see Visual Learning Paths.
State Guide Catalog
| Chapter | What you will learn | Start from |
|---|---|---|
| 001: Follow a trade beyond the screen | Trace the browser, trade service, event transport, processor, database and position view as one business workflow. | Foundation: start here |
| 002: Give the browser one entry point | Route UI, REST and streaming traffic through one NGINX edge while retaining the baseline business flow. | 001-baseline-uncontainerized-parity |
| 003: Make an agent work within an explicit contract | Add generated instructions, architecture context and contributor guidance for repeatable agent-assisted work. | 002-edge-proxy-uncontainerized |
| 004: Containerize the application, then run it with Compose | Containerize the application services and web frontend, then use Docker Compose to run the containers together behind NGINX and check readiness. | 003-agentic-harness-foundation |
| 005: Replace persistence without changing the business contract | Move persistence to PostgreSQL while retaining account, trade and position behavior. | 004-containerized-compose-runtime |
| 006: Separate messaging semantics from transport | Replace internal messaging with NATS while preserving the trade-to-position workflow. | 005-postgres-database-replacement |
| 007: Explain behavior with telemetry | Add LGTM telemetry to connect a user action with logs, metrics and traces. | 006-messaging-nats-replacement |
| 008: Distinguish a market observation from a trade | Stream simulated market data and use price awareness while retaining the booking workflow. | 007-observability-lgtm-compose |
| 009: Model an order before it becomes a trade | Introduce limit orders, matching and fills while keeping orders distinct from executed trades. | 008-pricing-awareness-market-data |
| 010: Move the runtime without changing the trading lesson | Run C2 on Kubernetes and explain ingress, service routing and pod readiness. | 009-order-management-matcher |
| 011: Shorten the edit-and-observe loop | Use Tilt to orchestrate the local Kubernetes development loop. | 010-kubernetes-runtime |
| 012: Establish a reusable platform checkpoint | Treat C3 as a combined platform and functional checkpoint for subsequent branches. | 011-tilt-kubernetes-dev-loop |
| 013: Explore a platform abstraction as an alternative | Use Radius to describe the application and its resource relationships on Kubernetes. | 012-platform-convergence-c3 |
| 014: Pass intent between applications without executing a trade | Add FDC3 context and intent handling through Sail so another application can open a prefilled ticket. | 012-platform-convergence-c3 |
How To Use This Section
- Open a state guide from this catalog.
- Read its purpose and incoming transition, then follow the guided experiment.
- Record observations and answer the assessment questions.
- Use the system references and code comparison to explain what changed, then choose an onward learning state.
Recommended Starting Points For New State Design
004-containerized-compose-runtime(C0): Containerized Compose Runtime (NGINX Ingress)007-observability-lgtm-compose(C1): Observability with LGTM on Compose009-order-management-matcher(C2): Order Management and Matcher012-platform-convergence-c3(C3): Platform Convergence C3