hb-docs

Documentation for Honey Badger robots.

Documentation structure

• Getting Started — robot introduction and key specs
• First Startup — first startup checklist
• Safety — safety and emergency procedures
• Setup — package contents, network reference, charging
• Control Console — Steam Deck controller and operator console
• Physical Overview — mechanical overview
• Connectors — connectors, buttons, and port reference
• Software Overview — ROS2 architecture and core topics
• Platform — onboard LPC/APC platform roles
• Messages — custom ROS2 message reference
• Networking — Wi-Fi, SSH, and ROS2 network notes
• Geometry — coordinate frames and leg geometry
• Payload — payload mount and spool configuration

Building

Prepare build environment

sudo apt install python3-venv
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txt

Build the docs

jupyter-book build .

Pushing & Merging

Before every merge, do a typos check with:

typos