Skip to content

Last Updated: 2026-05-04 Owner: Docs-Dev Summary: Running record of notable documentation-system updates, additions, and maintenance changes for QuantMatrix.

QuantMatrix Documentation Changelog

This changelog tracks meaningful updates to the documentation set.

2026-05-04

Added

  • repository structure guide for organizing QuantMatrix as a multi-project repository
  • README placeholders for future UI, API, backend process, shared, and infrastructure directories

Updated

  • MkDocs configuration to live fully under documentation/
  • GitHub Pages workflow to build from documentation/mkdocs.yml
  • local docs commands to use documentation/requirements-docs.txt and documentation/mkdocs.yml
  • README repository layout to reflect applications, services, shared code, infrastructure, and documentation boundaries
  • docs navigation and catalog inputs to include the repository structure guide

2026-05-03

Added

  • MkDocs site scaffold with Material theme configuration
  • documentation landing page
  • documentation contributor workflow
  • documentation style guide
  • UI document alignment review
  • top-of-file documentation metadata convention

Updated

  • master index to include the UI alignment review
  • TODO document to include implementation-alignment follow-up work
  • legacy portal parser to ignore metadata headers
  • document metadata to include a Summary field across the main docs set
  • documentation catalog generator to prefer Summary metadata for the purpose column
  • documentation catalog and PDF mirrors after the metadata refresh
  • documentation set to include a dedicated MkDocs platform guide
  • docs home page and README to point the local docs site to port 8011
  • documentation set to include a GitHub Pages publishing checklist
  • documentation set to include GitHub docs check-in steps for moving docs from the Codex workspace into the real repository

Notes

  • The existing custom documentation portal remains available during the MkDocs transition.
  • MkDocs is now the recommended next-generation docs surface for local preview and future publishing.