TraderX Documentation Portal

TraderX is a SpecKit-first reference trading system.

Start Here

1. Read the project orientation:
   • Getting Started
2. Generate and run the baseline from requirements:
   • Spec Kit Generation Guide
3. Understand the end-to-end workflow and quality gates:
   • GitHub Spec Kit Workflow

Browse Canonical Sources

• Feature Specs Catalog
• Spec Kit Constitution and Templates
• API Explorer

Where Is All The Code?

All TraderX state code lives in this same repository. The canonical source is specs in main, and runnable code snapshots are published as generated-state branches and tags.

• Generated State Branches Guide
• Generated-State Branches on GitHub
• Generated-State Tags on GitHub
• State Catalog (catalog/state-catalog.json)

Architecture Decisions

• Project ADRs (Architecture Decision Records)
• ADRs follow the MADR format/specification

Learning Paths and Future States

• Learning Guides
• Learning Paths
• SpecKit Strategy for State Transitions