Skip to content

Last Updated: 2026-05-04 Owner: Docs-Dev Summary: Metadata-driven catalog of the QuantMatrix documentation set with ownership, tags, freshness, and purpose.

QuantMatrix Documentation Catalog

This catalog provides a quick inventory of the documentation set using the metadata fields now stored in each document.

Use it to quickly answer: - what documents exist - who owns them - how they are tagged - when they were last updated - what each document is for

Refresh

Regenerate this file after metadata or navigation changes:

python3 documentation/tools/build_docs_catalog.py

Start Here

Title Tags Owner Last Updated Purpose
QuantMatrix Documentation Master Index docs, navigation, index Docs-Dev 2026-05-04 Master navigation page for the full QuantMatrix documentation set, organized by project phase and user role.
QuantMatrix Repository Structure Guide repository, structure, monorepo, organization Docs-Dev 2026-05-04 Recommended repository structure for keeping QuantMatrix clean as it grows across UI applications, APIs, backend processes, shared code, infrastructure, and documentation.
QuantMatrix TODO and Next Steps docs, maintenance, planning Docs-Dev 2026-05-03 Working list of documentation improvements, follow-up actions, and next-step maintenance items for QuantMatrix.
QuantMatrix UI Document Alignment Review ui, alignment, implementation UI-Dev 2026-05-03 Review of gaps between the documented target UI and the current MomentumTrader application screens and contracts.
QuantMatrix MkDocs Platform Guide docs, mkdocs, deployment Docs-Dev 2026-05-04 Reference guide for why the QuantMatrix MkDocs site exists, how it is stored, versioned, built, deployed, and accessed locally.
QuantMatrix GitHub Docs Check-In Steps docs, github, check-in Docs-Dev 2026-05-04 Step-by-step guide for moving the QuantMatrix documentation into the GitHub repository and checking in only the docs-related files.
QuantMatrix GitHub Pages Publishing Checklist docs, github-pages, deployment Ops-Dev 2026-05-04 Step-by-step checklist for publishing the QuantMatrix MkDocs site to GitHub Pages safely and cleanly.
QuantMatrix Documentation Contributor Workflow docs, workflow, maintenance Docs-Dev 2026-05-03 Process guide for updating, reviewing, and publishing documentation changes in the QuantMatrix docs system.
QuantMatrix Documentation Style Guide docs, style, maintenance Docs-Dev 2026-05-03 Writing and formatting standards for keeping QuantMatrix documentation clear, consistent, and maintainable.
QuantMatrix Documentation Changelog docs, changelog, maintenance Docs-Dev 2026-05-04 Running record of notable documentation-system updates, additions, and maintenance changes for QuantMatrix.
QuantMatrix MkDocs Build Prompt docs, mkdocs, automation Docs-Dev 2026-05-04 Reusable prompt for setting up, validating, and extending the QuantMatrix MkDocs documentation site.

Core Design

Title Tags Owner Last Updated Purpose
QuantMatrix System Design Prompt architecture, planning, core-design Docs-Dev 2026-05-03 Prompt for generating a full component-by-component system design document for QuantMatrix.
QuantMatrix Implementation Specification Prompt implementation, engineering, core-design Docs-Dev 2026-05-03 Prompt for converting the architecture design into implementation-ready module definitions, schemas, and build details.
QuantMatrix Trade Analytics Specification Prompt analytics, trades, strategy Docs-Dev 2026-05-03 Prompt for designing the trade analytics, labeling, review, and recommendation layer for QuantMatrix.

Build and Delivery

Title Tags Owner Last Updated Purpose
QuantMatrix Module Build Checklist Pack build, checklist, delivery Docs-Dev 2026-05-03 Module-by-module completion checklist pack for building QuantMatrix safely and in the right order.
QuantMatrix Project Roadmap and Milestone Plan roadmap, delivery, planning Docs-Dev 2026-05-03 Roadmap that translates the QuantMatrix design into milestones, dependencies, and phased delivery outcomes.
QuantMatrix Notion-Style Execution Tracker execution, tracking, delivery Docs-Dev 2026-05-03 Structured task tracker template for managing QuantMatrix milestone work in a Notion-style board.
QuantMatrix Milestone Sprint Plan: First 4 Weeks sprint, delivery, planning Docs-Dev 2026-05-03 Four-week sprint plan that breaks the early QuantMatrix roadmap into practical weekly execution goals.
QuantMatrix Week 1 Execution Board execution, sprint, week-1 Docs-Dev 2026-05-03 Detailed Week 1 execution board with sequencing, checkpoints, and ownership-ready task groupings.
QuantMatrix Release Change Checklist release, checklist, operations Ops-Dev 2026-05-03 Tactical checklist for validating, shipping, and watching any meaningful release change in QuantMatrix.
QuantMatrix Production Readiness Review Template release, readiness, operations Ops-Dev 2026-05-03 Formal review template for judging whether a QuantMatrix release is ready for production use.

Operations and Runtime

Title Tags Owner Last Updated Purpose
QuantMatrix Operations Runbook operations, runtime, safety Ops-Dev 2026-05-03 Day-to-day operating guide for running QuantMatrix safely across startup, monitoring, incidents, and shutdown.
QuantMatrix Live Trading Go-Live Checklist live-trading, operations, checklist Ops-Dev 2026-05-03 Final readiness checklist for promoting QuantMatrix from paper validation into live trading with real capital.
QuantMatrix Deployment Guide deployment, operations, environments Ops-Dev 2026-05-03 Environment-by-environment deployment guide for local, paper, backtest, and live QuantMatrix rollouts.

Incident and Recovery

Title Tags Owner Last Updated Purpose
QuantMatrix Incident Response Playbook incident, recovery, operations Ops-Dev 2026-05-03 Response guide for diagnosing, containing, and recovering from operational incidents in QuantMatrix.
QuantMatrix Post-Incident Review Template incident, review, operations Ops-Dev 2026-05-03 Structured template for documenting root cause, impact, and follow-up actions after a QuantMatrix incident.

Trading Review and Learning

Title Tags Owner Last Updated Purpose
QuantMatrix Daily Trade Review Template trade-review, analytics, learning Strategy-Dev 2026-05-03 Session review template for analyzing trades, execution quality, risk behavior, and next-day adjustments.
QuantMatrix Strategy Catalog Template strategy, analytics, governance Strategy-Dev 2026-05-03 Standard template for documenting strategy logic, assumptions, validation history, and governance status.

Data and Contracts

Title Tags Owner Last Updated Purpose
QuantMatrix Data Dictionary and Schema Reference data, schema, contracts Data-Dev 2026-05-03 Reference for QuantMatrix entities, tables, Redis keys, events, and analytics fields.
QuantMatrix API Reference Document api, contracts, integration API-Dev 2026-05-03 API contract reference for the QuantMatrix backend endpoints, payloads, and error conventions.
QuantMatrix Event Contract Reference events, contracts, redis Process-Dev 2026-05-03 Event and Redis stream contract reference for producers, consumers, envelopes, and idempotency rules.