Ekumen-OS / andino_docs

Manages andino ecosystem documentation
https://andino.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
0 stars 0 forks source link

[Debate] Documentation organization #2

Open francocipollone opened 1 week ago

francocipollone commented 1 week ago

Summary

This issue is meant to be used as discussion point to define the documentation organization hosted at: https://andino.readthedocs.io/en/latest/package_summary/andino_description.html

No matter what we have right now, or what docs we have in the repositories. Let's think the best way we could provide the docs to users. (Mostly to new ones). Let's think what we want to have online, later on we see how we adapt the current packages' info

Documentation organization

I will keep this updated:

1. Overview
  1.1 Andino Ecosystem
  1.2 Motivation

2. Building your robot
  2.1 Bill Of Materials
  2.2 Connections Diagram
  2.3 Assembly Process
  2.4 Calibrate your andino
  2.5 First steps

3. Getting started
  3.1 Connect to your andino
  3.2 Bringup Andino 
  3.3 Visualize sensor data using RViz
  3.4 Teleoperate your robot.

4. Advanced
  4.1 Use andino for mapping (SLAM)
  4.2 Navigate with andino.

5. Simulation

6. Andino ecosystem
  6.1 Main packages
  6.2 Related projects

7. Community
   7.1 How to contribute
   7.2 Discord   
francocipollone commented 1 week ago

CC @jballoffet @JesusSilvaUtrera