nasa
`ogma-cli`: Order of sections in README is sub-optimal
Description
The order of sections in the README puts ROS at the bottom, but the file would be best organized putting the backends implemented first, before the C structs (which are Copilot-specific and likely not used by as many users as the ROS/cFS commands).
Type
- Bug: order of elements in documentation makes understanding harder.
Additional context
None.
Requester
- Ivan Perez
Method to check presence of bug
The issue is with the documentation. There is no good, simple automated way to check that it is correct.
Because it's not a programming issue, visual inspection is OK.
Expected result
The README lists the main Copilot, cFS and ROS backend use first, and then lists the C structs parsing features.
Desired result
The README lists the main Copilot, cFS and ROS backend use first, and then lists the C structs parsing features.
Proposed solution
Change order of contents, and table of contents, in README, to put ROS ahead of C structs everywhere.
Further notes
None.
