OpenSimulationInterface / open-simulation-interface

A generic interface for the environmental perception of automated driving functions in virtual scenarios.
Other
271 stars 127 forks source link

Documentation of some top-level messages is missing #836

Closed TimmRuppert closed 1 week ago

TimmRuppert commented 1 month ago

Describe the bug

According to this page TrafficCommandUpdate and HostVehicleData are top-level messages but they are missing a sub chapter in "2.2.2 Top-level interfaces"

Describe how to reproduce the bug

Steps to reproduce the behavior:

  1. Go to https://opensimulationinterface.github.io/osi-antora-generator/asamosi/V3.7.0/interface/architecture/architecture_overview.html
  2. Compare the first paragraph with the chapters under 2.2.2

Describe the expected behavior

A "Top-level interfaces" chapters should include all top-level messages.

Show some screenshots

image

Additional context

When adding those chapters it would also recommend doing the following:

I have never used TrafficCommandUpdate and thus might not be the expert to provide a quick chapter about it. In case there is nobody suitable available to fix this issue I could provide a PR where I simply copy the text of the class description

philipwindecker commented 1 month ago

I am no expert regarding OSI content, so I will refrain from discussion the pros and cons of using messages vs. interfaces, particularly with protobuf (where, to my understanding, you define messages, not interfaces). For now, I left both message(s) and interface(s) as is. I was involved in this project to update the document generation process and introduce build tool improvements as well as an automated release pipeline. Content-related changes should be decided by the group and then, if necessary, fixed throughout the whole document (possibly through this or another branch/PR).

Regarding the missing sections and files: I added new pages and used content from the interface specification. I also took the liberty of adding links to the (doxygen) reference pages since this should benefit the reader if they wanted to learn more details than just the broad overview.