[Diagram Editor] Config example browser

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
frontend

Research direction

Read issue #115 to understand the existing help text and config-example data, then review issue #105 before starting. Locate the frontend path that exposes the help text and determine how users can browse and select the available examples; done means the previously hidden examples are accessible in the diagram editor.

Written by the indexing model from the issue text.

Description

#115 introduces both a help text description of a node builder and a list of config examples with explanations of each example, however the PR only exposes the help text description to the front end, leaving the config examples hidden.

We should follow up with some UI element that allows users to browse and select example configs. This should probably come after #105 since that one is more crucial for UX.

Dominant language
Rust
Stars
75
Forks
18
Avg merge
12d 12h
Merged PRs (30d)
3

Getting set up

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.

More from open-rmf/crossflow

All issues in open-rmf/crossflow

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.