Documentation for Honey Badger robots.
- 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, spool, camera and lidar configuration
sudo apt install python3-venv
python3 -m venv venv
. venv/bin/activate
pip install -r requirements.txtjupyter-book build .Before the docs move to a new software version, build the PDF of the current one and add it to downloads/ and the list in intro.md. Put the version in title in _config.yml first, then:
jupyter-book build --all --builder pdflatex .
gs -q -sDEVICE=pdfwrite -dPDFSETTINGS=/printer -dNOPAUSE -dBATCH -sOutputFile=downloads/hb-docs-v<version>.pdf _build/latex/book.pdfNeeds LaTeX (latexmk, xelatex) and Ghostscript. Revert the title change afterwards.
Before every merge, do a typos check with:
typos