mkdocs.yml

site_name: RQM Platform
site_description: Product documentation for RQM circuit optimization, execution routing, and geometry-native analysis.
site_url: https://docs.rqmtechnologies.com/

repo_name: RQM-Technologies-dev/rqm-docs
repo_url: https://github.com/RQM-Technologies-dev/rqm-docs

theme:
  name: material
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - scheme: default
      primary: deep purple
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - navigation.indexes
    - navigation.expand
    - content.action.edit
    - content.tooltips
    - search.highlight
    - content.code.copy

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra_javascript:
  - assets/js/pdf-export.js

extra_css:
  - assets/css/pdf-print.css
  - assets/css/rqm-modern.css

nav:
  - Home: index.md
  - Company & Product Map: company-overview.md
  - Agent Connect:
      - Agent Portal: agents/index.md
      - Prompt Pack: agents/prompts.md
      - Cursor / Codex Setup: agents/cursor.md
      - MCP Server Plan: agents/mcp.md
      - Agent Contract: agents/contract.md
      - Compliance Checklist: agents/contract-checklist.md
      - Contract Tests: agents/contract-tests.md
      - Agent Recipes:
          - Overview: agents/recipes/index.md
          - README for Agents: agents/recipes/README-for-agents.md
          - Validate → Optimize: agents/recipes/validate-optimize.md
          - RQM Studio Workflow: agents/recipes/studio-workflow.md
          - API Client Generation: agents/recipes/client-generation.md
          - Production vs Research Boundary: agents/recipes/research-boundary.md
  - Getting Started:
      - Quickstart: getting-started/quickstart.md
      - Installation: installation.md
      - SDK / local setup: getting-started/sdk-local-setup.md
  - Platform:
      - Overview: platform/overview.md
      - Architecture: platform/architecture.md
      - Ecosystem: platform/ecosystem.md
      - Canonical Circuit Boundary (rqm-circuits): platform/canonical-circuit-boundary.md
      - Optimization Engine (rqm-compiler): platform/optimization-engine.md
      - Execution Bridges (rqm-qiskit, rqm-braket, rqm-pennylane): platform/execution-bridges.md
  - Products:
      - RQM Studio: products/rqm-studio.md
      - Optimization API: products/optimization-api.md
      - Execution Workflows: products/execution-workflows.md
      - Verification / Trust: products/verification-trust.md
  - API:
      - API Overview: api/overview.md
      - Circuits: api/circuits.md
      - Execution: api/execution.md
      - Billing & Wallet: api/billing-and-wallet.md
      - Auth: api/authentication.md
      - Chat & TTS: api/chat-and-tts.md
      - Compiler Actions: api/compiler-actions.md
  - Concepts:
      - Quaternion intuition: concepts/quaternion-intuition.md
      - Spinors and Bloch sphere: concepts/spinor-bloch.md
      - SU(2) geometry: concepts/su2-geometry.md
      - Global phase: concepts/global-phase.md
      - Canonical IR (u1q): compiler/canonical-ir.md
  - Research:
      - QCE 2026 paper draft: research/qce2026-u1q-paper.md
  - Legacy & Archive:
      - Legacy Architecture Redirect: architecture.md
      - Legacy Ecosystem Redirect: ecosystem.md
      - Legacy Concepts Redirect: concepts.md
      - Legacy Optimization Redirect: optimization.md
      - Legacy Quickstart Redirect: quickstart.md
      - Legacy API Quickstart Redirect: api/quickstart.md
      - Notebooks and Learning Path: notebooks.md
      - Backends (Legacy API page): api/backends.md
      - Coupling Analysis (Legacy API page): api/coupling-analysis.md
      - Execution Capabilities (Legacy API page): api/execution-capabilities.md
      - Precision Timing (Coming Soon): precision-timing/index.md
      - Quantum Communication (Coming Soon): quantum-communication/index.md