OpenSimulationInterface / open-simulation-interface

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

Addition of General Description to Test Scripts Documentation #785

Closed yash-shah-asam closed 3 months ago

yash-shah-asam commented 4 months ago

Please review this addition, focusing on the completeness, clarity, and accuracy of the general description. Further improvement or refinement might be necessary. Please note, this update does not yet include the documentation's location in the navigation bar."

#### Reference to a related issue in the repository Issue #763

Add a description

General Description to the Test Scripts is added in Documentation.

Take this checklist as orientation for yourself, if this PR is ready for the Change Control Board:

If you can’t check all of them, please explain why. If all boxes are checked or commented and you have achieved at least one positive review, you can assign the label ReadyForCCBReview!

ClemensLinnhoff commented 4 months ago

Looks good, but it needs to be linked somewhere in the menu of the documentation. Currently it can only be found via the search, right?

pmai commented 4 months ago

Looks good, but it needs to be linked somewhere in the menu of the documentation. Currently it can only be found via the search, right?

Also, it should likely follow the ASAM documentation guidelines, e.g. one sentence per line in ASCII doc.

pmai commented 4 months ago

CCB 2024-03-11: Should be added as a new section 4.4 between 4.3 Contributing changes and existing 4.4 Reviewing contributions, ASM guideline cleanups needed, to be re-reviewed in next CCB.

yash-shah-asam commented 3 months ago

moved to OSI documentation Repo (Pull req"Adding test scripts to the nav # 73")