Last Updated: 2026-05-04 Owner: Docs-Dev Summary: Landing page for the QuantMatrix documentation site with guided entry points into the main doc groups.
QuantMatrix Docs¶
Welcome to the QuantMatrix documentation hub.
This site is the structured, searchable home for: - architecture - implementation planning - execution tracking - operations - incident handling - trade analytics
What This Site Is For¶
Use this site when you want one place to: - understand the system clearly - find the latest planning documents quickly - compare current implementation against target design - keep delivery, API, and operations work aligned
Best Place To Start¶
If you are new to the project, read these first:
- Master Index
- Repository Structure Guide
- Architecture Design Prompt
- Implementation Spec Prompt
- Trade Analytics Spec Prompt
- UI Document Alignment Review
Current Documentation Model¶
The docs currently follow a simple rule:
- target-state docs describe what QuantMatrix is intended to become
- current-state docs explain what the current implementation already does
This helps us avoid confusing “what exists today” with “what we are aiming for.”
Quick Navigation¶
Start Here¶
- Documentation Catalog
- Master Index
- Repository Structure Guide
- TODO and Next Steps
- UI Document Alignment Review
- MkDocs Platform Guide
- GitHub Docs Check-In Steps
- GitHub Pages Publishing Checklist
Build and Delivery¶
- Project Roadmap and Milestone Plan
- Execution Tracker
- Milestone Sprint Plan: First 4 Weeks
- Week 1 Execution Board
Runtime and Operations¶
Shared Contracts¶
Local Usage¶
Once MkDocs dependencies are installed, run:
Then open:
Notes¶
- The Markdown files in
documentation/docs/remain the source of truth. - The older custom static portal can remain in place during transition.
- GitHub Pages publishing can be layered on once the site structure feels stable.