Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Improvements based on use case partner feedback #293

Merged
merged 39 commits into from
Sep 14, 2022

Conversation

passalis
Copy link
Collaborator

@passalis passalis commented Aug 31, 2022

This PR includes the following changes:

  • Removed wrongly placed __init__.py.
  • Included a python folder in projects where all python examples are placed to avoid mixing them with the C examples and ROS nodes.
  • Improved structure of the documentation and toolkit to make it more user friendly.
  • Improved projects documentation.
  • A dedicated page that includes compatibility issues.
  • Additional information on how to modify a docker image without rebuilding it.
  • Information on how customizing ROS pipelines and running multiple tools
  • Instructions on how to build custom docker images that do not include the whole toolkit
  • Group ROS nodes based on the input they receive in order to make it easier for users to understand how to use them.

@passalis passalis marked this pull request as draft August 31, 2022 09:56
This was referenced Aug 31, 2022
@passalis passalis marked this pull request as ready for review August 31, 2022 12:56
Copy link
Collaborator

@stefaniapedrazzi stefaniapedrazzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for these improvements!

I think it would be also nice to add the two new pages "issues.md" and "customize.md" in docs/reference/index.md

passalis and others added 4 commits September 1, 2022 13:05
Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
@stefaniapedrazzi
Copy link
Collaborator

The index is fine.
Maybe I would just move the "Known issues" at the end, so that it is not one of the first page a user will read from the documentation.

@passalis passalis added test sources Run style checks test tools Test the toolkit methods test release Tests if a wheel created from a branch runs correctly labels Sep 1, 2022
@passalis
Copy link
Collaborator Author

passalis commented Sep 1, 2022

I agree, I moved it to the bottom. I also added the labels for running the tests, just to be safe.

@passalis passalis removed the test tools Test the toolkit methods label Sep 12, 2022
@passalis
Copy link
Collaborator Author

This is now ready for review again.

Copy link
Collaborator

@stefaniapedrazzi stefaniapedrazzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Co-authored-by: Stefania Pedrazzi <stefaniapedrazzi@users.noreply.github.com>
@passalis passalis merged commit 795b199 into develop Sep 14, 2022
@passalis passalis deleted the feedback_improvements branch September 14, 2022 07:43
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
test release Tests if a wheel created from a branch runs correctly test sources Run style checks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants