maliput / maliput/delphyne

Update Delphyne Guide

Open
#806 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

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. https://github.com/ToyotaResearchInstitute/delphyne_gui/issues/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)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Delphyne Guide 2021 document and review the two unchecked items: the RoadMap section and the Plot widget section, which references delphyne_gui issue 456. Done means the guide reflects the current project status and documents the relevant widget state accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.