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

Update Delphyne Guide #806

Open
28 of 30 tasks
francocipollone opened this issue Sep 13, 2021 · 0 comments
Open
28 of 30 tasks

Update Delphyne Guide #806

francocipollone opened this issue Sep 13, 2021 · 0 comments

Comments

@francocipollone
Copy link
Collaborator

francocipollone commented Sep 13, 2021

Context

Delphyne guide hasn't been updated for a while and lately many changes related to the ignition migration have taken place.

I've created another document based on the first one as it can be modified. Delphyne Guide 2021

Tasks

On code

On document

  • Correct naming in the entire document: e.g delphyne-replay --> delphyne_replay
  • Update pictures using ign-gui3 based visualizer when necessary.
  • Update Build & Installation section which also implies a modification at delphyne's README that is outdated.
  • Update Style Checking & Formatting section: cpplint isn't being used.
  • Verify code snippets related to Python layer.
  • Verify info about Agent Framework.
  • Adds an example on how to use the Agent.
  • Adds info about BehaviorTree machinery
  • Update On the RoadMap section(?)
  • Update collision detection snippet code as it doesn't work.
  • Update info about PlaybackWidget as it was replaced by PlaybackPlugin.
  • Update Manipulating the Time Stream section.
  • Plot widget section: It wasn't migrated to ign-gui3. Plot plugin delphyne_gui#456
  • Add info about the teleop plugin
  • Add info about the TopicStats plugin
  • Add info about the TopicViewer plugin
  • Update info about Scene Tree Widget: This plugin was reimplemented as ign-gui3 didn't migrate it from ign-gui0.
  • Update Displays Widget section as many were reimplemented.
  • Adds info about gui configuration save/load.

Bonus

  • This guide probably should be added to maliput_documentation/ delphyne_documentation(if exists in the future)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant