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

ogma-cli: Order of sections in README is sub-optimal #73

Open
ivanperez-keera opened this issue Jan 28, 2023 · 0 comments
Open

ogma-cli: Order of sections in README is sub-optimal #73

ivanperez-keera opened this issue Jan 28, 2023 · 0 comments
Labels
CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Bug Admin only: Change request pertaining to error detected

Comments

@ivanperez-keera
Copy link
Member

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.

@ivanperez-keera ivanperez-keera added CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Bug Admin only: Change request pertaining to error detected labels Jan 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Bug Admin only: Change request pertaining to error detected
Projects
None yet
Development

No branches or pull requests

2 participants
@ivanperez-keera and others