# TraderX Documentation Portal

> For the complete documentation index, see [llms.txt](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/llms.txt).

TraderX is a SpecKit-first reference trading system.

## Start Here

1.  Read the project orientation:
    *   [Getting Started](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/spec-kit/getting-started-with-traderx.md)
2.  Generate and run the baseline from requirements:
    *   [Spec Kit Generation Guide](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/spec-kit/spec-kit-generation-guide.md)
3.  Understand the end-to-end workflow and quality gates:
    *   [GitHub Spec Kit Workflow](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/spec-kit/spec-kit-workflow.md)

## Browse Canonical Sources

*   [Feature Specs Catalog](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/specs.md)
*   [Spec Kit Constitution and Templates](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/specify/memory/constitution.md)
*   [API Explorer (Runtime)](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/spec-kit/api-explorer.md)

## 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](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/spec-kit/generated-state-branches.md)
*   [Generated-State Branches on GitHub](https://github.com/finos/traderX/branches/all?query=code%2Fgenerated-state-)
*   [Generated-State Tags on GitHub](https://github.com/finos/traderX/tags?query=generated%2F)
*   [State Catalog (`catalog/state-catalog.json`)](https://github.com/finos/traderX/blob/main/catalog/state-catalog.json)

## Live Demos

*   [TraderX Demo (State 004)](https://demo.traderx.finos.org/)
*   [TraderX Advanced Demo (State 009)](https://demo-advanced.traderx.finos.org/)
*   [Live Environments Registry](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/spec-kit/live-environments.md)

## Architecture Decisions

*   [Project ADRs (Architecture Decision Records)](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/adr.md)
*   ADRs follow the [MADR format/specification](https://github.com/adr/madr)

## Learning Paths and Future States

*   [Learning Guides](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/learning.md)
*   [Learning Paths](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/learning-paths.md)
*   [SpecKit Strategy for State Transitions](https://deploy-preview-472--lucky-concha-f3599f.netlify.app/docs/spec-kit/spec-kit-learning-path-strategy.md)
