Seeing the current <a href="https://autowarefoundation.gitlab.io/autoware.auto/Autowar

I'd like to re-organize this into like this. Introduction<ul

Revisit documentation tree structure for more usability,about autowarefoundation/autoware-documentation

mitsudome-r commented on July 4, 2024 1

For Tuning section, we should think of a way of describing tuning instruction in design document of each package and the Tuning guide in autoware-documention should be a collection of links to the package instruction. Same for customization.
We don't want to have these documents heavily dependent on implementation since it is difficult to keep documents up-to-date while we do the development.

from autoware-documentation.

kenji-miyake commented on July 4, 2024

I'd like to re-organize this into like this.

Introduction
- About Autoware
- About this documentation
Installation
- Supported platforms
- Installation of Autoware
  - Local
  - Docker
- Installation of tools for users
- Installation of tools for developers
Tutorials
- Planning simulation
- Log data simulation
- E2E simulation
- Scenario testing
How-to guides
- Integration
  - Hardware setup
    - Vehicle setup
    - ECU setup
    - Sensors setup
  - Software setup
    - Customizing
    - Tuning
    - Map creation
- Write a node
- How to debug
- etc.
Design
- Overview
- Component interfaces
- AD API
- Repository structure
- Development process
- Release process
Contributing
- Overview
  - License / code of conduct
  - Contribution workflow
- Coding guidelines
  - Specific languages
    - C++
    - Python
    - etc.
  - ROS node design
    - topic namespace
    - launch
    - parameter
    - console logging
    - etc.
- Testing guidelines
- Documentation guidelines
- Pull request guidelines
Help
- Support guidelines
- Links to related documents