Central documentation, architecture, safety, compatibility, and onboarding repository for the OpenAMRobot ecosystem.
This repository acts as the single source of truth for:
- system architecture
- onboarding
- hardware/software integration
- safety documentation
- interface documentation
- communication standards
- compatibility matrices
- tutorials
- troubleshooting
- contributor documentation
openamr-platform-sw
ROS 2 software, simulation, navigation, docking, drivers, perception, and bringup.
openamr-platform-fw
Embedded firmware, microcontroller code, low-level interfaces, and hardware communication.
openamr-platform-hw
CAD, chassis, electrical systems, manufacturing files, BOM lists, and mechatronics.
openamrobot-interfaces
ROS 2 messages, services, actions, schemas, and interface contracts.
openamrobot-ui
Operator UI and user-facing applications.
openamrobot-docs/
├── docs/
├── assets/
├── mkdocs.yml
└── README.md
- getting started
- architecture
- safety
- communication
- interfaces
- UI
- software
- hardware
- firmware
- navigation
- docking
- software
- hardware
- firmware
Documentation should be:
- contributor-friendly
- beginner-accessible
- technically precise
- architecture-oriented
- version-aware
- maintainable
- reusable
Planned future additions:
- compatibility matrices
- deployment guides
- manufacturing workflows
- calibration procedures
- CI/CD documentation
- fleet management
- API references
- educational materials
Documentation license to be finalized.
Expected future direction:
- documentation: CC-BY-SA-4.0
- technical assets: MIT where applicable