Skip to content

Last Updated: 2026-05-04 Owner: Docs-Dev Summary: Master navigation page for the full QuantMatrix documentation set, organized by project phase and user role.

QuantMatrix Documentation Master Index

This is the master navigation document for the QuantMatrix documentation set.

Its purpose is to make it easy to find the right document at the right stage of the project: - planning - architecture - implementation - testing - operations - deployment - trade review - incident response - release readiness

Use this as the top-level entry point for the entire documentation pack.

If you are starting from scratch, read in this order:

  1. Architecture Design Prompt
  2. Repository Structure Guide
  3. Implementation Spec Prompt
  4. Trade Analytics Spec Prompt
  5. Documentation Catalog
  6. TODO and Next Steps
  7. UI Document Alignment Review
  8. MkDocs Platform Guide
  9. Module Build Checklist Pack
  10. Operations Runbook
  11. Live Trading Go-Live Checklist
  12. Incident Response Playbook
  13. Daily Trade Review Template
  14. Production Readiness Review Template
  15. Release Change Checklist
  16. Post-Incident Review Template
  17. Deployment Guide
  18. Project Roadmap and Milestone Plan
  19. Notion-Style Execution Tracker
  20. Milestone Sprint Plan: First 4 Weeks
  21. Week 1 Execution Board
  22. Data Dictionary and Schema Reference
  23. API Reference Document
  24. Strategy Catalog Template
  25. Event Contract Reference
  26. Documentation Contributor Workflow
  27. Documentation Style Guide
  28. Documentation Changelog
  29. GitHub Docs Check-In Steps
  30. GitHub Pages Publishing Checklist
  31. MkDocs Build Prompt

2. Core Design Documents

These documents define what QuantMatrix is and how it should be built.

Architecture Design Prompt

  • Purpose: generate the full system design document
  • Best use: component boundaries, technology choices, data flow, reliability planning
  • Files:
  • Markdown

Implementation Spec Prompt

  • Purpose: turn architecture into an implementation-ready engineering specification
  • Best use: modules, files, APIs, schemas, configs, build order
  • Files:
  • Markdown

Trade Analytics Spec Prompt

  • Purpose: define how trades are captured, analyzed, explained, and turned into recommendations
  • Best use: post-trade learning, feature capture, analytics schema, recommendations
  • Files:
  • Markdown

TODO and Next Steps

  • Purpose: keep the current documentation recommendations and immediate follow-up work visible
  • Best use: docs maintenance, portal evolution, deciding when to move to MkDocs
  • Files:
  • Markdown

UI Document Alignment Review

  • Purpose: compare the current MomentumTrader implementation against the QuantMatrix documentation set
  • Best use: resolving doc drift, identifying current-state vs target-state gaps, aligning UI and API docs
  • Files:
  • Markdown

Documentation Catalog

  • Purpose: provide a single inventory view of all documents using title, tags, owner, and last-updated metadata
  • Best use: quick discovery, ownership lookup, metadata-driven navigation, maintenance reviews
  • Files:
  • Markdown

Repository Structure Guide

  • Purpose: define how the repository should be organized across UI apps, APIs, backend processes, shared code, infrastructure, and documentation
  • Best use: repository cleanup, monorepo planning, future project placement, and Git organization decisions
  • Files:
  • Markdown

MkDocs Build Prompt

  • Purpose: provide a reusable prompt to recreate or continue the MkDocs documentation-platform setup
  • Best use: AI-assisted docs-platform work, environment rebuilds, handoff to another engineer or model
  • Files:
  • Markdown

MkDocs Platform Guide

  • Purpose: explain why the MkDocs site exists, how it is stored, versioned, built, deployed, and accessed locally
  • Best use: docs platform onboarding, repository setup, local preview workflow, and GitHub Pages handoff
  • Files:
  • Markdown

GitHub Pages Publishing Checklist

  • Purpose: provide a safe, step-by-step path from local MkDocs preview to hosted GitHub Pages publishing
  • Best use: repository setup, Pages enablement, first publish validation, and hosted docs handoff
  • Files:
  • Markdown

GitHub Docs Check-In Steps

  • Purpose: explain exactly how to move the docs from the Codex workspace into the real GitHub repository and commit only the documentation assets
  • Best use: first repository check-in, docs-only commit flow, and GitHub onboarding from a non-git local folder
  • Files:
  • Markdown

3. Build and Delivery Documents

These documents help the engineering team build safely and in the right order.

Module Build Checklist Pack

  • Purpose: module-by-module build completion checklist
  • Best use: implementation tracking, readiness checks, dependency-aware build flow
  • Files:
  • Markdown

Release Change Checklist

  • Purpose: lightweight release checklist for everyday changes
  • Best use: bug fixes, feature releases, config updates, UI changes, broker or analytics changes
  • Files:
  • Markdown

Production Readiness Review Template

  • Purpose: formal go / no-go review before major releases or live changes
  • Best use: live rollout, broker changes, major strategy or risk changes
  • Files:
  • Markdown

Project Roadmap and Milestone Plan

  • Purpose: sequence the platform into dependency-aware delivery milestones
  • Best use: roadmap planning, milestone review, execution sequencing
  • Files:
  • Markdown

Notion-Style Execution Tracker

  • Purpose: convert milestones into tasks, owners, dependencies, and status tracking
  • Best use: execution management, weekly reviews, delivery tracking
  • Files:
  • Markdown

Milestone Sprint Plan: First 4 Weeks

  • Purpose: turn the roadmap into a concrete first-month execution plan
  • Best use: immediate build sequencing, weekly delivery focus, and first-month coordination
  • Files:
  • Markdown

Week 1 Execution Board

  • Purpose: turn the first sprint week into an owner-based execution board
  • Best use: immediate task sequencing, daily focus, and end-of-week review
  • Files:
  • Markdown

4. Operations and Runtime Documents

These documents are for operating QuantMatrix safely day to day.

Operations Runbook

  • Purpose: day-to-day operating manual
  • Best use: startup, shutdown, monitoring, reconciliation, emergency procedures
  • Files:
  • Markdown

Live Trading Go-Live Checklist

  • Purpose: final readiness gate before real capital is used
  • Best use: first live launch, major live changes, restricted-capital rollout planning
  • Files:
  • Markdown

Deployment Guide

  • Purpose: deployment path from local to paper to live
  • Best use: environment setup, rollout order, validation, rollback
  • Files:
  • Markdown

5. Incident and Recovery Documents

These documents help the team respond well when something goes wrong.

Incident Response Playbook

  • Purpose: in-the-moment response instructions during incidents
  • Best use: broker outages, duplicate orders, mismatches, emergency halts
  • Files:
  • Markdown

Post-Incident Review Template

  • Purpose: structured review after an incident
  • Best use: severity 1 and 2 events, safety failures, reconciliation failures, serious operational issues
  • Files:
  • Markdown

6. Trading Review and Learning Documents

These documents support daily learning and iterative improvement.

Daily Trade Review Template

  • Purpose: end-of-session review
  • Best use: performance review, winner/loser analysis, execution review, next-session improvements
  • Files:
  • Markdown

Strategy Catalog Template

  • Purpose: standardize how individual strategies are documented and reviewed
  • Best use: strategy onboarding, tuning history, paper-to-live promotion readiness
  • Files:
  • Markdown

7. Data and Contract Reference Documents

These documents define the shared contracts that keep modules aligned.

Data Dictionary and Schema Reference

  • Purpose: define entities, tables, Redis keys, enums, and field meanings
  • Best use: implementation alignment, analytics alignment, schema review
  • Files:
  • Markdown

API Reference Document

  • Purpose: define REST-style runtime contracts
  • Best use: frontend/backend alignment, testing, endpoint implementation
  • Files:
  • Markdown

Event Contract Reference

  • Purpose: define internal stream and event payload contracts
  • Best use: Redis stream integration, replay, analytics, consumer implementation
  • Files:
  • Markdown

8. Suggested Usage by Project Phase

Phase A: Define the System

Use: - Architecture Design Prompt - Implementation Spec Prompt - Trade Analytics Spec Prompt - UI Document Alignment Review

Phase B: Build the Platform

Use: - Module Build Checklist Pack - Project Roadmap and Milestone Plan - Notion-Style Execution Tracker - Milestone Sprint Plan: First 4 Weeks - Week 1 Execution Board - Release Change Checklist

Phase C: Prepare for Runtime

Use: - Operations Runbook - Deployment Guide - Production Readiness Review Template

Phase D: Prepare for Live Trading

Use: - Live Trading Go-Live Checklist - Incident Response Playbook

Phase E: Learn and Improve

Use: - Daily Trade Review Template - Post-Incident Review Template - Trade Analytics Spec Prompt

Phase F: Lock Down Contracts

Use: - Data Dictionary and Schema Reference - API Reference Document - Event Contract Reference - Strategy Catalog Template

Phase G: Maintain The Documentation System

Use: - Documentation Catalog - TODO and Next Steps - MkDocs Platform Guide - GitHub Docs Check-In Steps - GitHub Pages Publishing Checklist - Documentation Contributor Workflow - Documentation Style Guide - Documentation Changelog - MkDocs Build Prompt

9. Suggested Usage by Role

For Architects / Lead Engineers

  • Architecture Design Prompt
  • Implementation Spec Prompt
  • Trade Analytics Spec Prompt
  • Production Readiness Review Template
  • Data Dictionary and Schema Reference
  • Event Contract Reference

For Backend / Platform Engineers

  • Implementation Spec Prompt
  • UI Document Alignment Review
  • Module Build Checklist Pack
  • Deployment Guide
  • Release Change Checklist
  • API Reference Document
  • Data Dictionary and Schema Reference
  • Event Contract Reference

For Operators

  • Operations Runbook
  • Live Trading Go-Live Checklist
  • Incident Response Playbook
  • Daily Trade Review Template

For Strategy Owners

  • Trade Analytics Spec Prompt
  • Daily Trade Review Template
  • Production Readiness Review Template
  • Strategy Catalog Template

For Project Leads / Delivery Owners

  • Project Roadmap and Milestone Plan
  • UI Document Alignment Review
  • Notion-Style Execution Tracker
  • Milestone Sprint Plan: First 4 Weeks
  • Week 1 Execution Board
  • Release Change Checklist
  • Production Readiness Review Template

For Documentation Maintainers

  • Documentation Catalog
  • TODO and Next Steps
  • MkDocs Platform Guide
  • GitHub Docs Check-In Steps
  • GitHub Pages Publishing Checklist
  • Documentation Contributor Workflow
  • Documentation Style Guide
  • Documentation Changelog
  • MkDocs Build Prompt

10. Minimum Starter Set

If you want the smallest useful doc set to start work, begin with: - Architecture Design Prompt - Implementation Spec Prompt - Module Build Checklist Pack - Operations Runbook

11. Full Documentation Set

Current document set:

  1. Architecture Design Prompt
  2. Implementation Spec Prompt
  3. Trade Analytics Spec Prompt
  4. Documentation Catalog
  5. TODO and Next Steps
  6. UI Document Alignment Review
  7. MkDocs Platform Guide
  8. Module Build Checklist Pack
  9. Operations Runbook
  10. Live Trading Go-Live Checklist
  11. Incident Response Playbook
  12. Daily Trade Review Template
  13. Production Readiness Review Template
  14. Release Change Checklist
  15. Post-Incident Review Template
  16. Deployment Guide
  17. Project Roadmap and Milestone Plan
  18. Notion-Style Execution Tracker
  19. Milestone Sprint Plan: First 4 Weeks
  20. Week 1 Execution Board
  21. Data Dictionary and Schema Reference
  22. API Reference Document
  23. Strategy Catalog Template
  24. Event Contract Reference
  25. Documentation Contributor Workflow Markdown
  26. Documentation Style Guide Markdown
  27. Documentation Changelog Markdown
  28. GitHub Docs Check-In Steps
  29. GitHub Pages Publishing Checklist
  30. MkDocs Build Prompt Markdown

Possible next documents: - Broker onboarding checklist - Redis consumer group reference - OpenAPI / JSON schema package - first release notes template - paper-trading readiness checklist