maliput / maliput/maliput_documentation

Small improvement on maliput overview's picture

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

Nobody has claimed this yet.

enhancement
Dominant language
CMake
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

### Summary

In the Maliput Overview section there is this image:
![image](https://user-images.githubusercontent.com/53065142/213733534-53f871f6-66a6-4e26-b112-fbd87eee5c46.png)

While it is ok, there could be improvements to better explain the difference between the lane, segment and junction entities.

### Proposal
- Segments A, B, and C should be part of a junction.
- 1_0, 2_0, 3_0 shouldn't be part of the same intersection junction, they should be different junctions.

Also, demo maps like TShapeRoad would follow this pattern for the intersection.

Contributor guide

Open the contributing guide

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 in the Maliput Overview documentation and locate the embedded image shown in the issue; no file or test path is provided. Update the illustration so segments A, B, and C belong to one junction while 1_0, 2_0, and 3_0 belong to separate junctions, consistent with the TShapeRoad example. Done means the overview clearly distinguishes lanes, segments, and junctions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.