You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When I started using Autoware, I often used the documentation and found that many chapters or even entire pages were empty.
Here is my claim from my own experience: It is more frustrating if there are pages in the documentation but they are empty than if the pages simply do not exist.
--> So my suggestion would be to comment out all the empty pages and chapters in the source code of the docu, so that anyone who wants to edit the documentation can see the ideas of the pages and chapters, but they are not still present as placeholders in the finished documentation
--Below are some examples of links to pages/chapters that I simply found WITHOUT SEARCHING FOR THEM.--
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
When I started using Autoware, I often used the documentation and found that many chapters or even entire pages were empty.
Here is my claim from my own experience: It is more frustrating if there are pages in the documentation but they are empty than if the pages simply do not exist.
--> So my suggestion would be to comment out all the empty pages and chapters in the source code of the docu, so that anyone who wants to edit the documentation can see the ideas of the pages and chapters, but they are not still present as placeholders in the finished documentation
--Below are some examples of links to pages/chapters that I simply found WITHOUT SEARCHING FOR THEM.--
Empty pages:
https://autowarefoundation.github.io/autoware-documentation/main/tutorials/ad-hoc-simulation/
https://autowarefoundation.github.io/autoware-documentation/main/tutorials/scenario-simulation/
https://autowarefoundation.github.io/autoware-documentation/main/installation/related-tools/
https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/sensing/data-types/image/
https://autowarefoundation.github.io/autoware-documentation/main/design/configuration-management/
https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/sensing/data-types/image/#image-pre-processing-design
https://autowarefoundation.github.io/autoware-documentation/main/design/configuration-management/development-process/
https://autowarefoundation.github.io/autoware-documentation/main/design/configuration-management/repository-structure/
https://autowarefoundation.github.io/autoware-documentation/main/design/configuration-management/release-process/
https://autowarefoundation.github.io/autoware.universe/main/evaluator/localization_evaluator/
https://autowarefoundation.github.io/autoware.universe/main/tools/rqt_diagnostic_graph_monitor/
Nearly empty pages (the name of it's page is as content):
https://autowarefoundation.github.io/autoware.universe/main/common/cuda_utils/#purpose
https://autowarefoundation.github.io/autoware.universe/main/common/component_interface_tools/
https://autowarefoundation.github.io/autoware.universe/main/common/object_recognition_utils/
https://autowarefoundation.github.io/autoware.universe/main/common/perception_utils/
https://autowarefoundation.github.io/autoware.universe/main/common/tensorrt_common/
https://autowarefoundation.github.io/autoware.universe/main/common/traffic_light_utils/
https://autowarefoundation.github.io/autoware.universe/main/common/autoware_ad_api_specs/
https://autowarefoundation.github.io/autoware.universe/main/common/component_interface_specs/
Empty chapters:
https://autowarefoundation.github.io/autoware-documentation/main/design/#conclusion
https://autowarefoundation.github.io/autoware-documentation/main/design/#design
https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-interfaces/ad-api/features/perception/#description
https://autowarefoundation.github.io/autoware.universe/main/common/autoware_auto_geometry/design/polygon_intersection_2d-design/#future-work
Empty chapters (for consistency - but if the only a few pages of that topic have there content in that chapter, shouldn't they have it as a 'exception' and every page of the topic without content in the chapter shouldn't have that chapter?):
https://autowarefoundation.github.io/autoware.universe/main/perception/object_merger/#assumptions-known-limits
https://autowarefoundation.github.io/autoware.universe/main/perception/euclidean_cluster/#assumptions-known-limits
https://autowarefoundation.github.io/autoware.universe/main/perception/detected_object_validation/object-position-filter/#assumptions-known-limits
https://autowarefoundation.github.io/autoware.universe/main/perception/detected_object_validation/object-lanelet-filter/#assumptions-known-limits
https://autowarefoundation.github.io/autoware.universe/main/perception/detected_object_feature_remover/#assumptions-known-limits
https://autowarefoundation.github.io/autoware.universe/main/perception/crosswalk_traffic_light_estimator/#assumptions-known-limits
https://autowarefoundation.github.io/autoware.universe/main/perception/compare_map_segmentation/#assumptions-known-limits
https://autowarefoundation.github.io/autoware.universe/main/perception/cluster_merger/#assumptions-known-limits
Beta Was this translation helpful? Give feedback.
All reactions