mkdocs.yml

# SPDX-FileCopyrightText: 2025-2026 Miko Parkkinen
# SPDX-License-Identifier: MIT

site_name: Metriplane documentation
site_description: >-
  Install Metriplane, understand a recorded bounded-workcell incident, and
  turn it into a repeatable regression check.
repo_url: https://github.com/Miko997/metriplane
repo_name: Miko997/metriplane
docs_dir: docs
site_dir: site
strict: true

theme:
  name: mkdocs

nav:
  - Home: README.md
  - Quickstart: user-guide/quickstart.md
  - What Metriplane does: user-guide/what-metriplane-does.md
  - Missing-tool example: user-guide/missing-tool-example.md
  - Inputs and outputs: user-guide/inputs-and-outputs.md
  - CLI: user-guide/cli.md
  - Process rules: user-guide/process-rules.md
  - Use your own recorded run: user-guide/use-your-own-run.md
  - External fixtures: user-guide/external-fixtures.md
  - Integrations and support: user-guide/integrations.md
  - External Source Contract:
      - Contract v1: specs/external-source-contract-v1.md
      - Source-truth audit: specs/external-source-contract-v1-audit.md
  - Cross-adapter validation:
      - Coverage audit: specs/cross-adapter-validation-audit-v1.md
      - Compatibility gate: specs/cross-adapter-compatibility-gate-v1.md
  - Bounded MassRobotics AMR replay: specs/massrobotics-amr-offline-replay-profile-v1.md
  - ManiSkill PickCube proof: user-guide/maniskill-pickcube-proof.md
  - External source-family matrix:
      - Landing page: user-guide/external-source-family-matrix-v1/README.md
      - Human-readable matrix: user-guide/external-source-family-matrix-v1/MATRIX.md
      - Source and license crosswalk: user-guide/external-source-family-matrix-v1/SOURCE-CROSSWALK.md
      - Provenance crosswalk: user-guide/external-source-family-matrix-v1/PROVENANCE-CROSSWALK.md
      - State-model crosswalk: user-guide/external-source-family-matrix-v1/STATE-MODEL-CROSSWALK.md
      - Semantics register: user-guide/external-source-family-matrix-v1/SEMANTICS.md
      - Unsupported paths: user-guide/external-source-family-matrix-v1/UNSUPPORTED-PATHS.md
      - Reopening criteria: user-guide/external-source-family-matrix-v1/REOPENING.md
      - Evaluator packet: user-guide/external-source-family-matrix-v1/EVALUATOR.md
      - Partner summary: user-guide/external-source-family-matrix-v1/PARTNER-SUMMARY.md
      - Validation: user-guide/external-source-family-matrix-v1/VALIDATION.md
      - Readiness: user-guide/external-source-family-matrix-v1/READINESS.md
  - Bounded ROS 2 and MCAP profile:
      - Landing page: user-guide/ros2-mcap-recorded-state-profile/README.md
      - Candidate comparison: user-guide/ros2-mcap-recorded-state-profile/SOURCE-CANDIDATES.md
      - Source audit: user-guide/ros2-mcap-recorded-state-profile/SOURCE-AUDIT.md
      - Rights matrix: user-guide/ros2-mcap-recorded-state-profile/RIGHTS-MATRIX.md
      - Shared adapter evidence: user-guide/ros2-mcap-recorded-state-profile/SHARED-ADAPTER-EVIDENCE.md
      - Capability specification: user-guide/ros2-mcap-recorded-state-profile/SOURCE-ADAPTER-CAPABILITY.md
      - ManiSkill classification: user-guide/ros2-mcap-recorded-state-profile/MANISKILL-CAPABILITY.md
      - robomimic classification: user-guide/ros2-mcap-recorded-state-profile/ROBOMIMIC-CAPABILITY.md
      - Synthetic ROS 2 and MCAP classification: user-guide/ros2-mcap-recorded-state-profile/ROS2-MCAP-CAPABILITY.md
      - Recorded-state profile: user-guide/ros2-mcap-recorded-state-profile/PROFILE.md
      - Topic and entity mapping: user-guide/ros2-mcap-recorded-state-profile/TOPIC-MAPPING.md
      - Clock decision: user-guide/ros2-mcap-recorded-state-profile/CLOCK-DECISION.md
      - Frame and TF decision: user-guide/ros2-mcap-recorded-state-profile/TF-DECISION.md
      - Materialization decision: user-guide/ros2-mcap-recorded-state-profile/MATERIALIZATION.md
      - Field provenance: user-guide/ros2-mcap-recorded-state-profile/FIELD-PROVENANCE.md
      - Information loss: user-guide/ros2-mcap-recorded-state-profile/INFORMATION-LOSS.md
      - Negative tests: user-guide/ros2-mcap-recorded-state-profile/NEGATIVE-TESTS.md
      - Red-team record: user-guide/ros2-mcap-recorded-state-profile/RED-TEAM.md
      - Reproduction: user-guide/ros2-mcap-recorded-state-profile/REPRODUCE.md
      - Claims: user-guide/ros2-mcap-recorded-state-profile/CLAIMS.md
      - Readiness: user-guide/ros2-mcap-recorded-state-profile/READINESS.md
  - Troubleshooting: user-guide/troubleshooting.md
  - Contributing: user-guide/contributing.md
  - Research artifacts: user-guide/research-artifacts.md
  - Citing Metriplane: user-guide/citing.md

# The repository retains detailed technical, evaluation, and frozen-reproduction
# documents outside the first-time-user site. Their source remains available on
# GitHub; excluding them keeps this strict build focused on the curated front door.
exclude_docs: |
  *.md
  !README.md
  !user-guide/
  !user-guide/**
  !specs/external-source-contract-v1.md
  !specs/external-source-contract-v1-audit.md
  !specs/cross-adapter-validation-audit-v1.md
  !specs/cross-adapter-compatibility-gate-v1.md
  !specs/massrobotics-amr-offline-replay-profile-v1.md
  archive/**
  atlas/**
  benchmarks/**
  case-studies/**
  eval/**
  paper/**
  qa/**
  references/**
  releases/**
  reports/**
  review_kit/**
  validation/human-comprehension-results.json