Ekumen-OS / Ekumen-OS/andino_docs
[Debate] Documentation organization
- Dominant language
- No language data
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
### 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
```
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the current documentation at the linked ReadTheDocs package summary page and compare it with the proposed outline in this issue. Discuss and record an agreed organization for user-facing documentation; implementation can be scoped only after the structure is decided.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100