Public Doku rework #1037

New proposed structure for the public documentation as discussed between me and Jan.

Getting Started:

• Setup
  • Should have the same content as the README.md
  • Our install instructions are small enough that they fully fit inside here
  • Mention that Zenoh is required for almost all software to run
  • Mention that all commands need to be run from inside pixi shell or with pixi run
• Global Software Overview
  • Bringup Launch Scripts
  • High level data flow diagram
  • List of all bitbots packages + description, grouped by topic
• Testing in Simulation

Physical Robot:

• List of Robots
• Setting up Robot
  • Ansible setup steps. Will not be useful for most people, should explicitly mention that.
  • Competition Wi-Fi
• PiPlus Hardware overview.
  • What Motors & Joints are there?
  • What Computation devices are there?
  • What Sensors are there?
  • What other outputs are there? (Speaker & LCD display)
  • What ports are there? (USB. Which is which?)
• Starting the Robot
  • How to power on
  • Only motor power when joints are normal and no motion is running
  • Instructions for deploy tool sync & build
• How to connect & How to tmux
• Testing the Robot
  • See Deploying for warnings on when not to start
  • Start motion standalone
  • Start teleop
  • How to Extrinsic Calibration
• Hardware Checklist
• Configure & Launch a robot
  • See Starting the Robot for warnings on when not to start & how to build
  • Deploy script config & launch
  • Cleanup (tmux session, copy & delete rosbag)

Development:

• Coding Style & Git Commit conventions
• How we develop:
  • Create a branch named feature/*, fix/*, or docs/*
  • Always create a PR for anything that may be merged. If it's not finished, create a draft PR
  • Once it's ready, ask for review from relevant authors & respond/fix those comments
  • CI needs to pass
  • If you don't have the capacity to make a PR right now, open an issue
  • Add PRs and Issues to the Project board
• How to Document

Glossary

Package Documentation:

• (Insert list of all packages with non-empty docu)
• Instead of link to default directory index

To be removed:

• Configure hostnames
• Electronics Wolfgang
• Mechanics Wolfgang
• VS Code Dev Container
• Optimization with Optuna
• Testing the robot motion

To be reworked fully:

• Bitbots Lowlevel
• Hardware Checklist
• (Maybe) Testing the robot hardware and lowlevel software

Feel free to edit as needed to add additional points.