maliput / maliput/maliput_documentation

Adds diagram to the maliput_overview page

Open
#119 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

Provide a general diagram about the packages and how they are connected:
- apis (maliput, maliput_py)
- backends (maliput_dragway, multilane, malidrive, maliput_osm)
- tools (maliput_viz, maliput_object, maliput_object_py, maliput_sparse)

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 with the maliput_overview page and review the listed API, backend, and tool packages. Create a general diagram showing those packages and how they are connected; the work is done when the overview presents the requested package relationships clearly.

Written by the indexing model from the issue text.

Assessment

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.