Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revisit documentation tree structure for more usability #5

Closed
kenji-miyake opened this issue Dec 21, 2021 · 4 comments · Fixed by #14
Closed

Revisit documentation tree structure for more usability #5

kenji-miyake opened this issue Dec 21, 2021 · 4 comments · Fixed by #14

Comments

@kenji-miyake
Copy link
Contributor

kenji-miyake commented Dec 21, 2021

Seeing the current Autoware.Auto's documentation, some information is dispersed and some information is unnecessary.

image

It should be refined so that people can easily access the information they want with no confusion.

This issue addresses the tree structure and we'll consider each content in #6.

@kenji-miyake
Copy link
Contributor Author

kenji-miyake commented Dec 21, 2021

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

Although Doxygen API references are removed, we can add them by Doxybook2 if we really need them.

@kenji-miyake
Copy link
Contributor Author

We'll create an empty tree like the above and consider each content in #6.

@kenji-miyake
Copy link
Contributor Author

@mitsudome-r
Copy link
Member

From: https://gitlab.com/autowarefoundation/autoware-foundation/-/issues/192

  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants