Skip to content

MecaMate Documentation

This site contains the maintained documentation for the MecaMate ROS 2 AGV platform. Detailed local ownership lives in package and folder README.md files; this site stays focused on onboarding, development, deployment, testing, and API entry points.

Start Here

  • Getting Started - first local setup and container workflow
  • Development - image builds, workspace builds, docs, linting, and host GUI notes
  • Deployment - robot/workstation profiles, environment files, Tailscale, DDS, and production operation
  • Testing - workspace, interface, hardware, and documentation checks
  • API Reference - ROS package and interface documentation entry points

Current Repository Layout

.
├── compose/              # Compose profiles for robot and workstation deployments
├── config/               # Runtime config mounted into containers
├── docker/               # Entrypoints and in-container scripts
├── docs/                 # This MkDocs site
├── env/                  # Shared and target-specific environment files
├── make/                 # Modular make targets
├── mecamate_ws/          # ROS 2 workspace
├── scripts/              # Host-side scripts
└── services/mecamate/    # Dockerfiles